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

blob: 1474863358b1e0001cba119462896b4f0840ebb4 [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.targetPools.html">targetPools</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	79	<p class="firstline">Adds health check URLs to a target pool.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#addInstance">addInstance(project, region, targetPool, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	82	<p class="firstline">Adds an instance to a target pool.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	85	<p class="firstline">Retrieves an aggregated list of target pools.</p>
				86	<p class="toc_element">
				87	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				88	<p class="firstline">Retrieves the next page of results.</p>
				89	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<code><a href="#close">close()</a></code></p>
				91	<p class="firstline">Close httplib2 connections.</p>
				92	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	93	<code><a href="#delete">delete(project, region, targetPool, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	94	<p class="firstline">Deletes the specified target pool.</p>
				95	<p class="toc_element">
				96	<code><a href="#get">get(project, region, targetPool)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Returns the specified target pool. Gets a list of available target pools by making a list() request.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#getHealth">getHealth(project, region, targetPool, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	100	<p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	103	<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
				104	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	106	<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
				107	<p class="toc_element">
				108	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				109	<p class="firstline">Retrieves the next page of results.</p>
				110	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	<code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<p class="firstline">Removes health check URL from a target pool.</p>
				113	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	114	<code><a href="#removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	115	<p class="firstline">Removes instance URL from a target pool.</p>
				116	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	117	<code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	118	<p class="firstline">Changes a backup target pool's configurations.</p>
				119	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	120	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	121	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				122	<h3>Method Details</h3>
				123	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	124	<code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	125	<pre>Adds health check URLs to a target pool.
				126
				127	Args:
				128	project: string, Project ID for this request. (required)
				129	region: string, Name of the region scoping this request. (required)
				130	targetPool: string, Name of the target pool to add a health check to. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	131	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	132	The object takes the form of:
				133
				134	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	135	"healthChecks": [ # The HttpHealthCheck to add to the target pool.
				136	{ # A full or valid partial URL to a health check. For example, the following are valid URLs:
				137	# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
				138	# - projects/project-id/global/httpHealthChecks/health-check
				139	# - global/httpHealthChecks/health-check
				140	"healthCheck": "A String",
				141	},
				142	],
				143	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	144
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	145	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.
				146
				147	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.
				148
				149	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	150
				151	Returns:
				152	An object of the form:
				153
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	154	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	155	#
				156	# Google Compute Engine has three Operation resources:
				157	#
				158	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				159	#
				160	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				161	#
				162	# Operations can be global, regional or zonal.
				163	# - For global operations, use the `globalOperations` resource.
				164	# - For regional operations, use the `regionOperations` resource.
				165	# - For zonal operations, use the `zonalOperations` resource.
				166	#
				167	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				168	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				169	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				170	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				171	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				172	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				173	"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]	174	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	175	"code": "A String", # [Output Only] The error type identifier for this error.
				176	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				177	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	},
				179	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	180	},
				181	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				182	"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.
				183	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				184	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				185	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				186	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	187	"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]	188	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				189	"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.
				190	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				191	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				192	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				193	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				194	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				195	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				196	"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.
				197	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				198	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				199	{
				200	"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.
				201	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				202	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				203	{
				204	"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).
				205	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				206	},
				207	],
				208	"message": "A String", # [Output Only] A human-readable description of the warning code.
				209	},
				210	],
				211	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				212	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	213	</div>
				214
				215	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	216	<code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	217	<pre>Adds an instance to a target pool.
				218
				219	Args:
				220	project: string, Project ID for this request. (required)
				221	region: string, Name of the region scoping this request. (required)
				222	targetPool: string, Name of the TargetPool resource to add instances to. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	223	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	224	The object takes the form of:
				225
				226	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	227	"instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
				228	# - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
				229	# - projects/project-id/zones/zone/instances/instance-name
				230	# - zones/zone/instances/instance-name
				231	{
				232	"instance": "A String", # The URL for a specific instance.
				233	},
				234	],
				235	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	236
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	237	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.
				238
				239	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.
				240
				241	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	242
				243	Returns:
				244	An object of the form:
				245
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	246	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	247	#
				248	# Google Compute Engine has three Operation resources:
				249	#
				250	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				251	#
				252	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				253	#
				254	# Operations can be global, regional or zonal.
				255	# - For global operations, use the `globalOperations` resource.
				256	# - For regional operations, use the `regionOperations` resource.
				257	# - For zonal operations, use the `zonalOperations` resource.
				258	#
				259	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				260	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				261	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				262	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				263	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				264	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				265	"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]	266	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	267	"code": "A String", # [Output Only] The error type identifier for this error.
				268	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				269	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	270	},
				271	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	272	},
				273	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				274	"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.
				275	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				276	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				277	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				278	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	279	"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]	280	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				281	"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.
				282	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				283	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				284	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				285	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				286	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				287	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				288	"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.
				289	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				290	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				291	{
				292	"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.
				293	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				294	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				295	{
				296	"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).
				297	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				298	},
				299	],
				300	"message": "A String", # [Output Only] A human-readable description of the warning code.
				301	},
				302	],
				303	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				304	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	305	</div>
				306
				307	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	308	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	309	<pre>Retrieves an aggregated list of target pools.
				310
				311	Args:
				312	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	313	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	314
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	315	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	316
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	317	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	318
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	319	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]	320	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]	321	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`)
				322	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				323
				324	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.
				325
				326	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				327	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]	328	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	329
				330	Returns:
				331	An object of the form:
				332
				333	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	334	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				335	"items": { # A list of TargetPool resources.
				336	"a_key": { # Name of the scope containing this set of target pools.
				337	"targetPools": [ # A list of target pools contained in this scope.
				338	{ # Represents a Target Pool resource.
				339	#
				340	# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
				341	"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	342	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	343	# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
				344	#
				345	# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
				346	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				347	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				348	"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
				349	#
				350	# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
				351	#
				352	# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	353	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	354	"A String",
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	355	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	356	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				357	"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
				358	"A String",
				359	],
				360	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
				361	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				362	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				363	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				364	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
				365	# NONE: Connections from the same client IP may go to any instance in the pool.
				366	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				367	# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	368	},
				369	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	370	"warning": { # Informational warning which replaces the list of addresses when the list is empty.
				371	"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.
				372	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				373	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				374	{
				375	"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).
				376	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				377	},
				378	],
				379	"message": "A String", # [Output Only] A human-readable description of the warning code.
				380	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	381	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	382	},
				383	"kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
				384	"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.
				385	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				386	"unreachables": [ # [Output Only] Unreachable resources.
				387	"A String",
				388	],
				389	"warning": { # [Output Only] Informational warning message.
				390	"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.
				391	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				392	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				393	{
				394	"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).
				395	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				396	},
				397	],
				398	"message": "A String", # [Output Only] A human-readable description of the warning code.
				399	},
				400	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	401	</div>
				402
				403	<div class="method">
				404	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				405	<pre>Retrieves the next page of results.
				406
				407	Args:
				408	previous_request: The request for the previous page. (required)
				409	previous_response: The response from the request for the previous page. (required)
				410
				411	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	412	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]	413	page. Returns None if there are no more items in the collection.
				414	</pre>
				415	</div>
				416
				417	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	418	<code class="details" id="close">close()</code>
				419	<pre>Close httplib2 connections.</pre>
				420	</div>
				421
				422	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	423	<code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	424	<pre>Deletes the specified target pool.
				425
				426	Args:
				427	project: string, Project ID for this request. (required)
				428	region: string, Name of the region scoping this request. (required)
				429	targetPool: string, Name of the TargetPool resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	430	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.
				431
				432	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.
				433
				434	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	435
				436	Returns:
				437	An object of the form:
				438
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	439	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	440	#
				441	# Google Compute Engine has three Operation resources:
				442	#
				443	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				444	#
				445	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				446	#
				447	# Operations can be global, regional or zonal.
				448	# - For global operations, use the `globalOperations` resource.
				449	# - For regional operations, use the `regionOperations` resource.
				450	# - For zonal operations, use the `zonalOperations` resource.
				451	#
				452	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				453	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				454	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				455	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				456	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				457	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				458	"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]	459	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	460	"code": "A String", # [Output Only] The error type identifier for this error.
				461	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				462	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	463	},
				464	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	465	},
				466	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				467	"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.
				468	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				469	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				470	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				471	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	472	"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]	473	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				474	"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.
				475	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				476	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				477	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				478	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				479	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				480	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				481	"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.
				482	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				483	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				484	{
				485	"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.
				486	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				487	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				488	{
				489	"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).
				490	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				491	},
				492	],
				493	"message": "A String", # [Output Only] A human-readable description of the warning code.
				494	},
				495	],
				496	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				497	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	498	</div>
				499
				500	<div class="method">
				501	<code class="details" id="get">get(project, region, targetPool)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	502	<pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	503
				504	Args:
				505	project: string, Project ID for this request. (required)
				506	region: string, Name of the region scoping this request. (required)
				507	targetPool: string, Name of the TargetPool resource to return. (required)
				508
				509	Returns:
				510	An object of the form:
				511
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	512	{ # Represents a Target Pool resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	513	#
				514	# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
				515	"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	516	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	517	# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
				518	#
				519	# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
				520	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				521	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				522	"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
				523	#
				524	# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
				525	#
				526	# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	527	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	528	"A String",
				529	],
				530	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				531	"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
				532	"A String",
				533	],
				534	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
				535	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				536	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				537	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				538	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
				539	# NONE: Connections from the same client IP may go to any instance in the pool.
				540	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				541	# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
				542	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	543	</div>
				544
				545	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	546	<code class="details" id="getHealth">getHealth(project, region, targetPool, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	547	<pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
				548
				549	Args:
				550	project: string, Project ID for this request. (required)
				551	region: string, Name of the region scoping this request. (required)
				552	targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	553	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	554	The object takes the form of:
				555
				556	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	557	"instance": "A String", # The URL for a specific instance.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	558	}
				559
				560
				561	Returns:
				562	An object of the form:
				563
				564	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	565	"healthStatus": [
				566	{
				567	"annotations": { # Metadata defined as annotations for network endpoint.
				568	"a_key": "A String",
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	569	},
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	570	"forwardingRule": "A String", # URL of the forwarding rule associated with the health status of the instance.
				571	"forwardingRuleIp": "A String", # A forwarding rule IP address assigned to this instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	572	"healthState": "A String", # Health state of the instance.
				573	"instance": "A String", # URL of the instance resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	574	"ipAddress": "A String", # For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	575	"port": 42, # The named port of the instance group, not necessarily the port that is health-checked.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	576	"weight": "A String",
				577	"weightError": "A String",
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	578	},
				579	],
				580	"kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
				581	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	582	</div>
				583
				584	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	585	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	586	<pre>Creates a target pool in the specified project and region using the data included in the request.
				587
				588	Args:
				589	project: string, Project ID for this request. (required)
				590	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	591	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	592	The object takes the form of:
				593
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	594	{ # Represents a Target Pool resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	595	#
				596	# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	597	"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	598	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	599	# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
				600	#
				601	# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
				602	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				603	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				604	"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
				605	#
				606	# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
				607	#
				608	# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	609	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	610	"A String",
				611	],
				612	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				613	"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
				614	"A String",
				615	],
				616	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
				617	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				618	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				619	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				620	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
				621	# NONE: Connections from the same client IP may go to any instance in the pool.
				622	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				623	# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
				624	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	625
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	626	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.
				627
				628	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.
				629
				630	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	631
				632	Returns:
				633	An object of the form:
				634
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	635	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	636	#
				637	# Google Compute Engine has three Operation resources:
				638	#
				639	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				640	#
				641	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				642	#
				643	# Operations can be global, regional or zonal.
				644	# - For global operations, use the `globalOperations` resource.
				645	# - For regional operations, use the `regionOperations` resource.
				646	# - For zonal operations, use the `zonalOperations` resource.
				647	#
				648	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				649	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				650	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				651	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				652	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				653	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				654	"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]	655	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	656	"code": "A String", # [Output Only] The error type identifier for this error.
				657	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				658	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	659	},
				660	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	661	},
				662	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				663	"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.
				664	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				665	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				666	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				667	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	668	"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]	669	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				670	"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.
				671	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				672	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				673	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				674	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				675	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				676	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				677	"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.
				678	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				679	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				680	{
				681	"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.
				682	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				683	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				684	{
				685	"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).
				686	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				687	},
				688	],
				689	"message": "A String", # [Output Only] A human-readable description of the warning code.
				690	},
				691	],
				692	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				693	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	694	</div>
				695
				696	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	697	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	698	<pre>Retrieves a list of target pools available to the specified project and region.
				699
				700	Args:
				701	project: string, Project ID for this request. (required)
				702	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	703	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	704
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	705	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	706
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	707	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	708
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	709	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) ```
				710	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`)
				711	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				712
				713	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.
				714
				715	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				716	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]	717	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	718
				719	Returns:
				720	An object of the form:
				721
				722	{ # Contains a list of TargetPool resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	723	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				724	"items": [ # A list of TargetPool resources.
				725	{ # Represents a Target Pool resource.
				726	#
				727	# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
				728	"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	729	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	730	# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
				731	#
				732	# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
				733	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				734	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				735	"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
				736	#
				737	# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
				738	#
				739	# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	740	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	741	"A String",
				742	],
				743	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				744	"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
				745	"A String",
				746	],
				747	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
				748	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				749	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				750	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				751	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
				752	# NONE: Connections from the same client IP may go to any instance in the pool.
				753	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				754	# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
				755	},
				756	],
				757	"kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
				758	"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.
				759	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				760	"warning": { # [Output Only] Informational warning message.
				761	"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.
				762	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				763	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				764	{
				765	"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).
				766	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	767	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	768	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	769	"message": "A String", # [Output Only] A human-readable description of the warning code.
				770	},
				771	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	772	</div>
				773
				774	<div class="method">
				775	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				776	<pre>Retrieves the next page of results.
				777
				778	Args:
				779	previous_request: The request for the previous page. (required)
				780	previous_response: The response from the request for the previous page. (required)
				781
				782	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	783	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]	784	page. Returns None if there are no more items in the collection.
				785	</pre>
				786	</div>
				787
				788	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	789	<code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	790	<pre>Removes health check URL from a target pool.
				791
				792	Args:
				793	project: string, Project ID for this request. (required)
				794	region: string, Name of the region for this request. (required)
				795	targetPool: string, Name of the target pool to remove health checks from. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	796	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	797	The object takes the form of:
				798
				799	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	800	"healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
				801	# - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
				802	# - projects/project/global/httpHealthChecks/health-check
				803	# - global/httpHealthChecks/health-check
				804	{ # A full or valid partial URL to a health check. For example, the following are valid URLs:
				805	# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
				806	# - projects/project-id/global/httpHealthChecks/health-check
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	807	# - global/httpHealthChecks/health-check
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	808	"healthCheck": "A String",
				809	},
				810	],
				811	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	812
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	813	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.
				814
				815	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.
				816
				817	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	818
				819	Returns:
				820	An object of the form:
				821
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	822	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	823	#
				824	# Google Compute Engine has three Operation resources:
				825	#
				826	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				827	#
				828	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				829	#
				830	# Operations can be global, regional or zonal.
				831	# - For global operations, use the `globalOperations` resource.
				832	# - For regional operations, use the `regionOperations` resource.
				833	# - For zonal operations, use the `zonalOperations` resource.
				834	#
				835	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				836	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				837	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				838	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				839	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				840	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				841	"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]	842	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	843	"code": "A String", # [Output Only] The error type identifier for this error.
				844	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				845	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	846	},
				847	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	848	},
				849	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				850	"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.
				851	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				852	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				853	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				854	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	855	"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]	856	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				857	"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.
				858	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				859	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				860	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				861	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				862	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				863	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				864	"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.
				865	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				866	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				867	{
				868	"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.
				869	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				870	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				871	{
				872	"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).
				873	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				874	},
				875	],
				876	"message": "A String", # [Output Only] A human-readable description of the warning code.
				877	},
				878	],
				879	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				880	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	881	</div>
				882
				883	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	884	<code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	885	<pre>Removes instance URL from a target pool.
				886
				887	Args:
				888	project: string, Project ID for this request. (required)
				889	region: string, Name of the region scoping this request. (required)
				890	targetPool: string, Name of the TargetPool resource to remove instances from. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	891	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	892	The object takes the form of:
				893
				894	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	895	"instances": [ # URLs of the instances to be removed from target pool.
				896	{
				897	"instance": "A String", # The URL for a specific instance.
				898	},
				899	],
				900	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	901
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	902	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.
				903
				904	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.
				905
				906	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	907
				908	Returns:
				909	An object of the form:
				910
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	911	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	912	#
				913	# Google Compute Engine has three Operation resources:
				914	#
				915	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				916	#
				917	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				918	#
				919	# Operations can be global, regional or zonal.
				920	# - For global operations, use the `globalOperations` resource.
				921	# - For regional operations, use the `regionOperations` resource.
				922	# - For zonal operations, use the `zonalOperations` resource.
				923	#
				924	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				925	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				926	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				927	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				928	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				929	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				930	"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]	931	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	932	"code": "A String", # [Output Only] The error type identifier for this error.
				933	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				934	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	935	},
				936	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	937	},
				938	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				939	"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.
				940	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				941	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				942	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				943	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	944	"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]	945	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				946	"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.
				947	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				948	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				949	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				950	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				951	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				952	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				953	"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.
				954	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				955	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				956	{
				957	"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.
				958	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				959	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				960	{
				961	"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).
				962	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				963	},
				964	],
				965	"message": "A String", # [Output Only] A human-readable description of the warning code.
				966	},
				967	],
				968	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				969	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	970	</div>
				971
				972	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	973	<code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	974	<pre>Changes a backup target pool's configurations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	975
				976	Args:
				977	project: string, Project ID for this request. (required)
				978	region: string, Name of the region scoping this request. (required)
				979	targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	980	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	981	The object takes the form of:
				982
				983	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	984	"target": "A String",
				985	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	986
				987	failoverRatio: number, New failoverRatio value for the target pool.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	988	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				989
				990	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				991
				992	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	993
				994	Returns:
				995	An object of the form:
				996
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	997	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	998	#
				999	# Google Compute Engine has three Operation resources:
				1000	#
				1001	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1002	#
				1003	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1004	#
				1005	# Operations can be global, regional or zonal.
				1006	# - For global operations, use the `globalOperations` resource.
				1007	# - For regional operations, use the `regionOperations` resource.
				1008	# - For zonal operations, use the `zonalOperations` resource.
				1009	#
				1010	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1011	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1012	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1013	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1014	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1015	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1016	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1017	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1018	"code": "A String", # [Output Only] The error type identifier for this error.
				1019	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1020	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1021	},
				1022	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1023	},
				1024	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1025	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				1026	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1027	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1028	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1029	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1030	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1031	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1032	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1033	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1034	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1035	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1036	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1037	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1038	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1039	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1040	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1041	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1042	{
				1043	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1044	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1045	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1046	{
				1047	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				1048	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1049	},
				1050	],
				1051	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1052	},
				1053	],
				1054	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1055	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1056	</div>
				1057
				1058	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1059	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1060	<pre>Returns permissions that a caller has on the specified resource.
				1061
				1062	Args:
				1063	project: string, Project ID for this request. (required)
				1064	region: string, The name of the region for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1065	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]	1066	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1067	The object takes the form of:
				1068
				1069	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1070	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				1071	"A String",
				1072	],
				1073	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1074
				1075
				1076	Returns:
				1077	An object of the form:
				1078
				1079	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1080	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				1081	"A String",
				1082	],
				1083	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1084	</div>
				1085
				1086	</body></html>