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

blob: ecc2b2ca6c94f04fc29d4c3489b90d8b894472fa [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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instanceGroups.html">instanceGroups</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	78	<code><a href="#addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
				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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	80	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	81	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	90	<code><a href="#delete">delete(project, zone, instanceGroup, requestId=None, x__xgafv=None)</a></code></p>
				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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	92	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	93	<code><a href="#get">get(project, zone, instanceGroup, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	95	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	96	<code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	99	<code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	101	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	102	<code><a href="#listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	111	<code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
				112	<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances. 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.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	113	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	114	<code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	117	<code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	121	<code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
				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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	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	{
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	134	"instance": "A String", # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	135	},
				136	],
				137	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	138
yoshi-code-bot	3659137	2021-06-16 00:22:06 -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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				140	x__xgafv: string, V1 error format.
				141	Allowed values
				142	1 - v1 error format
				143	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	144
				145	Returns:
				146	An object of the form:
				147
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	148	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	149	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				150	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				151	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				152	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				153	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				154	"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]	155	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	156	"code": "A String", # [Output Only] The error type identifier for this error.
				157	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				158	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	159	},
				160	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	161	},
				162	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				163	"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.
				164	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				165	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				166	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	167	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				168	"a_key": "", # Properties of the object. Contains field @type with type URL.
				169	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	171	"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]	172	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				173	"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.
				174	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				175	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				176	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				177	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				178	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				179	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				180	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				181	"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.
				182	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				183	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				184	{
				185	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	186	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	187	{
				188	"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).
				189	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				190	},
				191	],
				192	"message": "A String", # [Output Only] A human-readable description of the warning code.
				193	},
				194	],
				195	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				196	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	197	</div>
				198
				199	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	200	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	201	<pre>Retrieves the list of instance groups and sorts them by zone.
				202
				203	Args:
				204	project: string, Project ID for this request. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	205	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` 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. 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]	206	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]	207	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`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	208	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	209	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]	210	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	211	x__xgafv: string, V1 error format.
				212	Allowed values
				213	1 - v1 error format
				214	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	215
				216	Returns:
				217	An object of the form:
				218
				219	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	220	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				221	"items": { # A list of InstanceGroupsScopedList resources.
				222	"a_key": { # The name of the scope that contains this set of instance groups.
				223	"instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	224	{ # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				226	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				227	"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.
				228	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				229	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				230	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	231	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 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}] Named ports apply to all instances in this instance group.
				232	{ # The named port. For example: <"http", 80>.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	233	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				234	"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]	235	},
				236	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"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).
				238	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				239	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				240	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				241	"size": 42, # [Output Only] The total number of instances in the instance group.
				242	"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).
				243	"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]	244	},
				245	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	246	"warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
				247	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	248	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	249	{
				250	"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).
				251	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				252	},
				253	],
				254	"message": "A String", # [Output Only] A human-readable description of the warning code.
				255	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	256	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	257	},
				258	"kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
				259	"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.
				260	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				261	"unreachables": [ # [Output Only] Unreachable resources.
				262	"A String",
				263	],
				264	"warning": { # [Output Only] Informational warning message.
				265	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	266	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	267	{
				268	"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).
				269	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				270	},
				271	],
				272	"message": "A String", # [Output Only] A human-readable description of the warning code.
				273	},
				274	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	275	</div>
				276
				277	<div class="method">
				278	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				279	<pre>Retrieves the next page of results.
				280
				281	Args:
				282	previous_request: The request for the previous page. (required)
				283	previous_response: The response from the request for the previous page. (required)
				284
				285	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	286	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]	287	page. Returns None if there are no more items in the collection.
				288	</pre>
				289	</div>
				290
				291	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	292	<code class="details" id="close">close()</code>
				293	<pre>Close httplib2 connections.</pre>
				294	</div>
				295
				296	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	297	<code class="details" id="delete">delete(project, zone, instanceGroup, requestId=None, x__xgafv=None)</code>
				298	<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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	299
				300	Args:
				301	project: string, Project ID for this request. (required)
				302	zone: string, The name of the zone where the instance group is located. (required)
				303	instanceGroup: string, The name of the instance group to delete. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	304	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				305	x__xgafv: string, V1 error format.
				306	Allowed values
				307	1 - v1 error format
				308	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	309
				310	Returns:
				311	An object of the form:
				312
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	313	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	314	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				315	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				316	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				317	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				318	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				319	"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]	320	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	321	"code": "A String", # [Output Only] The error type identifier for this error.
				322	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				323	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	324	},
				325	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	326	},
				327	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				328	"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.
				329	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				330	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				331	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	332	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				333	"a_key": "", # Properties of the object. Contains field @type with type URL.
				334	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	335	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	336	"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]	337	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				338	"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.
				339	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				340	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				341	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				342	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				343	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				344	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				345	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				346	"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.
				347	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				348	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				349	{
				350	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	351	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	352	{
				353	"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).
				354	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				355	},
				356	],
				357	"message": "A String", # [Output Only] A human-readable description of the warning code.
				358	},
				359	],
				360	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				361	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	362	</div>
				363
				364	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	365	<code class="details" id="get">get(project, zone, instanceGroup, x__xgafv=None)</code>
				366	<pre>Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	367
				368	Args:
				369	project: string, Project ID for this request. (required)
				370	zone: string, The name of the zone where the instance group is located. (required)
				371	instanceGroup: string, The name of the instance group. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	372	x__xgafv: string, V1 error format.
				373	Allowed values
				374	1 - v1 error format
				375	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	376
				377	Returns:
				378	An object of the form:
				379
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	380	{ # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	381	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				382	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				383	"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.
				384	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				385	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				386	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	387	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 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}] Named ports apply to all instances in this instance group.
				388	{ # The named port. For example: <"http", 80>.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	389	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				390	"port": 42, # The port number, which can be a value between 1 and 65535.
				391	},
				392	],
				393	"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).
				394	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				395	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				396	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				397	"size": 42, # [Output Only] The total number of instances in the instance group.
				398	"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).
				399	"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
				400	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	401	</div>
				402
				403	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	404	<code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	405	<pre>Creates an instance group in the specified project using the parameters that are included in the request.
				406
				407	Args:
				408	project: string, Project ID for this request. (required)
				409	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]	410	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	411	The object takes the form of:
				412
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	413	{ # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	414	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				415	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				416	"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.
				417	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				418	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				419	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	420	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 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}] Named ports apply to all instances in this instance group.
				421	{ # The named port. For example: <"http", 80>.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	422	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				423	"port": 42, # The port number, which can be a value between 1 and 65535.
				424	},
				425	],
				426	"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).
				427	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				428	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				429	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				430	"size": 42, # [Output Only] The total number of instances in the instance group.
				431	"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).
				432	"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
				433	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	434
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	435	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				436	x__xgafv: string, V1 error format.
				437	Allowed values
				438	1 - v1 error format
				439	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	440
				441	Returns:
				442	An object of the form:
				443
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	444	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	445	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				446	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				447	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				448	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				449	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				450	"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]	451	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	452	"code": "A String", # [Output Only] The error type identifier for this error.
				453	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				454	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	455	},
				456	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	457	},
				458	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				459	"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.
				460	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				461	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				462	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	463	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				464	"a_key": "", # Properties of the object. Contains field @type with type URL.
				465	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	466	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	467	"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]	468	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				469	"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.
				470	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				471	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				472	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				473	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				474	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				475	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				476	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				477	"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.
				478	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				479	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				480	{
				481	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	482	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	483	{
				484	"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).
				485	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				486	},
				487	],
				488	"message": "A String", # [Output Only] A human-readable description of the warning code.
				489	},
				490	],
				491	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				492	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	493	</div>
				494
				495	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	496	<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
				497	<pre>Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	498
				499	Args:
				500	project: string, Project ID for this request. (required)
				501	zone: string, The name of the zone where the instance group is located. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	502	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` 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. 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) ```
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	503	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`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	504	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	505	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]	506	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	507	x__xgafv: string, V1 error format.
				508	Allowed values
				509	1 - v1 error format
				510	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	511
				512	Returns:
				513	An object of the form:
				514
				515	{ # A list of InstanceGroup resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	516	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				517	"items": [ # A list of InstanceGroup resources.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	518	{ # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	519	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				520	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				521	"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.
				522	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				523	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				524	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	525	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} 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}] Named ports apply to all instances in this instance group.
				526	{ # The named port. For example: <"http", 80>.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	527	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				528	"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]	529	},
				530	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	531	"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).
				532	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				533	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				534	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				535	"size": 42, # [Output Only] The total number of instances in the instance group.
				536	"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).
				537	"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]	538	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	539	],
				540	"kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
				541	"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.
				542	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				543	"warning": { # [Output Only] Informational warning message.
				544	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	545	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	546	{
				547	"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).
				548	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				549	},
				550	],
				551	"message": "A String", # [Output Only] A human-readable description of the warning code.
				552	},
				553	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	554	</div>
				555
				556	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	557	<code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	558	<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]	559
				560	Args:
				561	project: string, Project ID for this request. (required)
				562	zone: string, The name of the zone where the instance group is located. (required)
				563	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]	564	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	565	The object takes the form of:
				566
				567	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	568	"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.
				569	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	570
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	571	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` 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. 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) ```
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	572	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`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	573	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	574	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]	575	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	576	x__xgafv: string, V1 error format.
				577	Allowed values
				578	1 - v1 error format
				579	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	580
				581	Returns:
				582	An object of the form:
				583
				584	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	585	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				586	"items": [ # A list of InstanceWithNamedPorts resources.
				587	{
				588	"instance": "A String", # [Output Only] The URL of the instance.
				589	"namedPorts": [ # [Output Only] The named ports that belong to this instance group.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	590	{ # The named port. For example: <"http", 80>.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	591	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				592	"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]	593	},
				594	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	595	"status": "A String", # [Output Only] The status of the instance.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	596	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	597	],
				598	"kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
				599	"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.
				600	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				601	"warning": { # [Output Only] Informational warning message.
				602	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	603	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	604	{
				605	"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).
				606	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				607	},
				608	],
				609	"message": "A String", # [Output Only] A human-readable description of the warning code.
				610	},
				611	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	612	</div>
				613
				614	<div class="method">
				615	<code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
				616	<pre>Retrieves the next page of results.
				617
				618	Args:
				619	previous_request: The request for the previous page. (required)
				620	previous_response: The response from the request for the previous page. (required)
				621
				622	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	623	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]	624	page. Returns None if there are no more items in the collection.
				625	</pre>
				626	</div>
				627
				628	<div class="method">
				629	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				630	<pre>Retrieves the next page of results.
				631
				632	Args:
				633	previous_request: The request for the previous page. (required)
				634	previous_response: The response from the request for the previous page. (required)
				635
				636	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	637	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]	638	page. Returns None if there are no more items in the collection.
				639	</pre>
				640	</div>
				641
				642	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	643	<code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
				644	<pre>Removes one or more instances from the specified instance group, but does not delete those instances. 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.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	645
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	646	Args:
				647	project: string, Project ID for this request. (required)
				648	zone: string, The name of the zone where the instance group is located. (required)
				649	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]	650	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	651	The object takes the form of:
				652
				653	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	654	"instances": [ # The list of instances to remove from the instance group.
				655	{
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	656	"instance": "A String", # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	657	},
				658	],
				659	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	660
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	661	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				662	x__xgafv: string, V1 error format.
				663	Allowed values
				664	1 - v1 error format
				665	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	666
				667	Returns:
				668	An object of the form:
				669
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	670	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	671	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				672	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				673	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				674	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				675	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				676	"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]	677	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	678	"code": "A String", # [Output Only] The error type identifier for this error.
				679	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				680	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	681	},
				682	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	683	},
				684	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				685	"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.
				686	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				687	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				688	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	689	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				690	"a_key": "", # Properties of the object. Contains field @type with type URL.
				691	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	692	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	693	"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]	694	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				695	"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.
				696	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				697	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				698	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				699	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				700	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				701	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				702	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				703	"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.
				704	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				705	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				706	{
				707	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	708	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	709	{
				710	"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).
				711	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				712	},
				713	],
				714	"message": "A String", # [Output Only] A human-readable description of the warning code.
				715	},
				716	],
				717	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				718	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	719	</div>
				720
				721	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	722	<code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	723	<pre>Sets the named ports for the specified instance group.
				724
				725	Args:
				726	project: string, Project ID for this request. (required)
				727	zone: string, The name of the zone where the instance group is located. (required)
				728	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]	729	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	730	The object takes the form of:
				731
				732	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	733	"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.
				734	"namedPorts": [ # The list of named ports to set for this instance group.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	735	{ # The named port. For example: <"http", 80>.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	736	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				737	"port": 42, # The port number, which can be a value between 1 and 65535.
				738	},
				739	],
				740	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	741
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	742	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				743	x__xgafv: string, V1 error format.
				744	Allowed values
				745	1 - v1 error format
				746	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	747
				748	Returns:
				749	An object of the form:
				750
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	751	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	752	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				753	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				754	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				755	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				756	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				757	"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]	758	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	759	"code": "A String", # [Output Only] The error type identifier for this error.
				760	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				761	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	762	},
				763	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	764	},
				765	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				766	"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.
				767	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				768	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				769	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	770	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				771	"a_key": "", # Properties of the object. Contains field @type with type URL.
				772	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	773	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	774	"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]	775	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				776	"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.
				777	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				778	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				779	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				780	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				781	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				782	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				783	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				784	"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.
				785	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				786	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				787	{
				788	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	789	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	790	{
				791	"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).
				792	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				793	},
				794	],
				795	"message": "A String", # [Output Only] A human-readable description of the warning code.
				796	},
				797	],
				798	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				799	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	800	</div>
				801
				802	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	803	<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	804	<pre>Returns permissions that a caller has on the specified resource.
				805
				806	Args:
				807	project: string, Project ID for this request. (required)
				808	zone: string, The name of the zone for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	809	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]	810	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	811	The object takes the form of:
				812
				813	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	814	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				815	"A String",
				816	],
				817	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	818
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	819	x__xgafv: string, V1 error format.
				820	Allowed values
				821	1 - v1 error format
				822	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	823
				824	Returns:
				825	An object of the form:
				826
				827	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	828	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				829	"A String",
				830	],
				831	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	832	</div>
				833
				834	</body></html>