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

blob: 12c6c1880535cf05886c8fea4b2871c0df43fd0d [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">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	78	<code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body, 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">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	81	<code><a href="#addInstance">addInstance(project, region, targetPool, body, 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">
				84	<code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
				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">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	90	<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]	91	<p class="firstline">Deletes the specified target pool.</p>
				92	<p class="toc_element">
				93	<code><a href="#get">get(project, region, targetPool)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<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]	95	<p class="toc_element">
				96	<code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p>
				97	<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>
				98	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	99	<code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	100	<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
				101	<p class="toc_element">
				102	<code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
				103	<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
				104	<p class="toc_element">
				105	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				106	<p class="firstline">Retrieves the next page of results.</p>
				107	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	<code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	109	<p class="firstline">Removes health check URL from a target pool.</p>
				110	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	<code><a href="#removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<p class="firstline">Removes instance URL from a target pool.</p>
				113	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	<code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	115	<p class="firstline">Changes a backup target pool's configurations.</p>
				116	<p class="toc_element">
				117	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
				118	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				119	<h3>Method Details</h3>
				120	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	<code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	122	<pre>Adds health check URLs to a target pool.
				123
				124	Args:
				125	project: string, Project ID for this request. (required)
				126	region: string, Name of the region scoping this request. (required)
				127	targetPool: string, Name of the target pool to add a health check to. (required)
				128	body: object, The request body. (required)
				129	The object takes the form of:
				130
				131	{
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	132	"healthChecks": [ # The HttpHealthCheck to add to the target pool.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	133	{ # A full or valid partial URL to a health check. For example, the following are valid URLs:
				134	# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
				135	# - projects/project-id/global/httpHealthChecks/health-check
				136	# - global/httpHealthChecks/health-check
				137	"healthCheck": "A String",
				138	},
				139	],
				140	}
				141
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	142	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.
				143
				144	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.
				145
				146	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]	147
				148	Returns:
				149	An object of the form:
				150
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	151	{ # Represents an Operation resource.
				152	#
				153	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				154	#
				155	# Operations can be global, regional or zonal.
				156	# - For global operations, use the globalOperations resource.
				157	# - For regional operations, use the regionOperations resource.
				158	# - For zonal operations, use the zonalOperations resource.
				159	#
				160	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	161	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	162	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	163	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	164	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	165	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	166	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				167	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				168	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				169	"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.
				170	"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.
				171	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				172	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				173	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				174	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				175	{
				176	"message": "A String", # [Output Only] A human-readable description of the warning code.
				177	"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.
				178	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				179	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				180	{
				181	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				182	"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).
				183	},
				184	],
				185	},
				186	],
				187	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				188	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				189	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				190	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	191	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	192	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				193	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				194	{
				195	"message": "A String", # [Output Only] An optional, human-readable error message.
				196	"code": "A String", # [Output Only] The error type identifier for this error.
				197	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				198	},
				199	],
				200	},
				201	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				202	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	203	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	204	}</pre>
				205	</div>
				206
				207	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	208	<code class="details" id="addInstance">addInstance(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	209	<pre>Adds an instance to a target pool.
				210
				211	Args:
				212	project: string, Project ID for this request. (required)
				213	region: string, Name of the region scoping this request. (required)
				214	targetPool: string, Name of the TargetPool resource to add instances to. (required)
				215	body: object, The request body. (required)
				216	The object takes the form of:
				217
				218	{
				219	"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:
				220	# - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
				221	# - projects/project-id/zones/zone/instances/instance-name
				222	# - zones/zone/instances/instance-name
				223	{
				224	"instance": "A String", # The URL for a specific instance.
				225	},
				226	],
				227	}
				228
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	229	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.
				230
				231	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.
				232
				233	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]	234
				235	Returns:
				236	An object of the form:
				237
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	238	{ # Represents an Operation resource.
				239	#
				240	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				241	#
				242	# Operations can be global, regional or zonal.
				243	# - For global operations, use the globalOperations resource.
				244	# - For regional operations, use the regionOperations resource.
				245	# - For zonal operations, use the zonalOperations resource.
				246	#
				247	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	248	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	249	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	250	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	251	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	252	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	253	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				254	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				255	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				256	"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.
				257	"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.
				258	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				259	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				260	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				261	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				262	{
				263	"message": "A String", # [Output Only] A human-readable description of the warning code.
				264	"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.
				265	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				266	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				267	{
				268	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				269	"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).
				270	},
				271	],
				272	},
				273	],
				274	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				275	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				276	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				277	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	278	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	279	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				280	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				281	{
				282	"message": "A String", # [Output Only] An optional, human-readable error message.
				283	"code": "A String", # [Output Only] The error type identifier for this error.
				284	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				285	},
				286	],
				287	},
				288	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				289	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	290	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	291	}</pre>
				292	</div>
				293
				294	<div class="method">
				295	<code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
				296	<pre>Retrieves an aggregated list of target pools.
				297
				298	Args:
				299	project: string, Project ID for this request. (required)
				300	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				301
				302	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.
				303
				304	Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	305	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)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	306	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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	307	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]	308
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	309	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]	310
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	311	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]	312
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	313	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).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	314
				315	Returns:
				316	An object of the form:
				317
				318	{
				319	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	320	"kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
				321	"items": { # A list of TargetPool resources.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	322	"a_key": { # Name of the scope containing this set of target pools.
				323	"warning": { # Informational warning which replaces the list of addresses when the list is empty.
				324	"message": "A String", # [Output Only] A human-readable description of the warning code.
				325	"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.
				326	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				327	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				328	{
				329	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				330	"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).
				331	},
				332	],
				333	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	334	"targetPools": [ # A list of target pools contained in this scope.
				335	{ # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	336	"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].
				337	#
				338	# 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.
				339	#
				340	# 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.
				341	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				342	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				343	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	344	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	345	# NONE: Connections from the same client IP may go to any instance in the pool.
				346	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				347	# 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.
				348	"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.
				349	"A String",
				350	],
				351	"backupPool": "A String", # 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].
				352	#
				353	# 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.
				354	#
				355	# 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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	356	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	357	"A String",
				358	],
				359	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				360	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				361	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	362	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	363	},
				364	],
				365	},
				366	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	367	"warning": { # [Output Only] Informational warning message.
				368	"message": "A String", # [Output Only] A human-readable description of the warning code.
				369	"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.
				370	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				371	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				372	{
				373	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				374	"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).
				375	},
				376	],
				377	},
				378	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	379	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				380	}</pre>
				381	</div>
				382
				383	<div class="method">
				384	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				385	<pre>Retrieves the next page of results.
				386
				387	Args:
				388	previous_request: The request for the previous page. (required)
				389	previous_response: The response from the request for the previous page. (required)
				390
				391	Returns:
				392	A request object that you can call 'execute()' on to request the next
				393	page. Returns None if there are no more items in the collection.
				394	</pre>
				395	</div>
				396
				397	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	398	<code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	399	<pre>Deletes the specified target pool.
				400
				401	Args:
				402	project: string, Project ID for this request. (required)
				403	region: string, Name of the region scoping this request. (required)
				404	targetPool: string, Name of the TargetPool resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	405	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.
				406
				407	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.
				408
				409	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]	410
				411	Returns:
				412	An object of the form:
				413
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	414	{ # Represents an Operation resource.
				415	#
				416	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				417	#
				418	# Operations can be global, regional or zonal.
				419	# - For global operations, use the globalOperations resource.
				420	# - For regional operations, use the regionOperations resource.
				421	# - For zonal operations, use the zonalOperations resource.
				422	#
				423	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	424	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	425	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	426	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	427	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	428	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	429	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				430	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				431	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				432	"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.
				433	"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.
				434	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				435	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				436	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				437	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				438	{
				439	"message": "A String", # [Output Only] A human-readable description of the warning code.
				440	"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.
				441	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				442	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				443	{
				444	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				445	"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).
				446	},
				447	],
				448	},
				449	],
				450	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				451	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				452	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				453	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	454	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	455	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				456	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				457	{
				458	"message": "A String", # [Output Only] An optional, human-readable error message.
				459	"code": "A String", # [Output Only] The error type identifier for this error.
				460	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				461	},
				462	],
				463	},
				464	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				465	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	466	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	467	}</pre>
				468	</div>
				469
				470	<div class="method">
				471	<code class="details" id="get">get(project, region, targetPool)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	472	<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]	473
				474	Args:
				475	project: string, Project ID for this request. (required)
				476	region: string, Name of the region scoping this request. (required)
				477	targetPool: string, Name of the TargetPool resource to return. (required)
				478
				479	Returns:
				480	An object of the form:
				481
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	482	{ # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	483	"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].
				484	#
				485	# 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.
				486	#
				487	# 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.
				488	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				489	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				490	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	491	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	492	# NONE: Connections from the same client IP may go to any instance in the pool.
				493	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				494	# 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.
				495	"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.
				496	"A String",
				497	],
				498	"backupPool": "A String", # 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].
				499	#
				500	# 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.
				501	#
				502	# 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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	503	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	504	"A String",
				505	],
				506	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				507	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				508	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	509	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	510	}</pre>
				511	</div>
				512
				513	<div class="method">
				514	<code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
				515	<pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
				516
				517	Args:
				518	project: string, Project ID for this request. (required)
				519	region: string, Name of the region scoping this request. (required)
				520	targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
				521	body: object, The request body. (required)
				522	The object takes the form of:
				523
				524	{
				525	"instance": "A String", # The URL for a specific instance.
				526	}
				527
				528
				529	Returns:
				530	An object of the form:
				531
				532	{
				533	"kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
				534	"healthStatus": [
				535	{
				536	"instance": "A String", # URL of the instance resource.
				537	"healthState": "A String", # Health state of the instance.
				538	"ipAddress": "A String", # The IP address represented by this resource.
				539	"port": 42, # The port on the instance.
				540	},
				541	],
				542	}</pre>
				543	</div>
				544
				545	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	546	<code class="details" id="insert">insert(project, region, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	547	<pre>Creates a target pool in the specified project and region using the data included in the request.
				548
				549	Args:
				550	project: string, Project ID for this request. (required)
				551	region: string, Name of the region scoping this request. (required)
				552	body: object, The request body. (required)
				553	The object takes the form of:
				554
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	555	{ # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	556	"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].
				557	#
				558	# 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.
				559	#
				560	# 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.
				561	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				562	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				563	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	564	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	565	# NONE: Connections from the same client IP may go to any instance in the pool.
				566	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				567	# 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.
				568	"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.
				569	"A String",
				570	],
				571	"backupPool": "A String", # 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].
				572	#
				573	# 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.
				574	#
				575	# 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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	576	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	577	"A String",
				578	],
				579	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				580	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				581	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	582	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	583	}
				584
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	585	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.
				586
				587	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.
				588
				589	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]	590
				591	Returns:
				592	An object of the form:
				593
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	594	{ # Represents an Operation resource.
				595	#
				596	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				597	#
				598	# Operations can be global, regional or zonal.
				599	# - For global operations, use the globalOperations resource.
				600	# - For regional operations, use the regionOperations resource.
				601	# - For zonal operations, use the zonalOperations resource.
				602	#
				603	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	604	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	605	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	606	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	607	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	608	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	609	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				610	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				611	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				612	"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.
				613	"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.
				614	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				615	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				616	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				617	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				618	{
				619	"message": "A String", # [Output Only] A human-readable description of the warning code.
				620	"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.
				621	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				622	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				623	{
				624	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				625	"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).
				626	},
				627	],
				628	},
				629	],
				630	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				631	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				632	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				633	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	634	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	635	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				636	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				637	{
				638	"message": "A String", # [Output Only] An optional, human-readable error message.
				639	"code": "A String", # [Output Only] The error type identifier for this error.
				640	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				641	},
				642	],
				643	},
				644	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				645	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	646	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	647	}</pre>
				648	</div>
				649
				650	<div class="method">
				651	<code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
				652	<pre>Retrieves a list of target pools available to the specified project and region.
				653
				654	Args:
				655	project: string, Project ID for this request. (required)
				656	region: string, Name of the region scoping this request. (required)
				657	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				658
				659	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.
				660
				661	Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	662	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)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	663	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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	664	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]	665
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	666	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]	667
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	668	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]	669
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	670	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).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	671
				672	Returns:
				673	An object of the form:
				674
				675	{ # Contains a list of TargetPool resources.
				676	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	677	"kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	678	"items": [ # A list of TargetPool resources.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	679	{ # A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	680	"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].
				681	#
				682	# 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.
				683	#
				684	# 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.
				685	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				686	"region": "A String", # [Output Only] URL of the region where the target pool resides.
				687	"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	688	"sessionAffinity": "A String", # Session affinity option, must be one of the following values:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	689	# NONE: Connections from the same client IP may go to any instance in the pool.
				690	# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
				691	# 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.
				692	"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.
				693	"A String",
				694	],
				695	"backupPool": "A String", # 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].
				696	#
				697	# 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.
				698	#
				699	# 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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	700	"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	701	"A String",
				702	],
				703	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				704	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				705	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	706	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	707	},
				708	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	709	"warning": { # [Output Only] Informational warning message.
				710	"message": "A String", # [Output Only] A human-readable description of the warning code.
				711	"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.
				712	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				713	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				714	{
				715	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				716	"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).
				717	},
				718	],
				719	},
				720	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	721	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				722	}</pre>
				723	</div>
				724
				725	<div class="method">
				726	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				727	<pre>Retrieves the next page of results.
				728
				729	Args:
				730	previous_request: The request for the previous page. (required)
				731	previous_response: The response from the request for the previous page. (required)
				732
				733	Returns:
				734	A request object that you can call 'execute()' on to request the next
				735	page. Returns None if there are no more items in the collection.
				736	</pre>
				737	</div>
				738
				739	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	740	<code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	741	<pre>Removes health check URL from a target pool.
				742
				743	Args:
				744	project: string, Project ID for this request. (required)
				745	region: string, Name of the region for this request. (required)
				746	targetPool: string, Name of the target pool to remove health checks from. (required)
				747	body: object, The request body. (required)
				748	The object takes the form of:
				749
				750	{
				751	"healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
				752	# - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
				753	# - projects/project/global/httpHealthChecks/health-check
				754	# - global/httpHealthChecks/health-check
				755	{ # A full or valid partial URL to a health check. For example, the following are valid URLs:
				756	# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
				757	# - projects/project-id/global/httpHealthChecks/health-check
				758	# - global/httpHealthChecks/health-check
				759	"healthCheck": "A String",
				760	},
				761	],
				762	}
				763
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	764	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.
				765
				766	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.
				767
				768	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]	769
				770	Returns:
				771	An object of the form:
				772
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	773	{ # Represents an Operation resource.
				774	#
				775	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				776	#
				777	# Operations can be global, regional or zonal.
				778	# - For global operations, use the globalOperations resource.
				779	# - For regional operations, use the regionOperations resource.
				780	# - For zonal operations, use the zonalOperations resource.
				781	#
				782	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	783	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	784	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	785	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	786	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	787	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	788	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				789	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				790	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				791	"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.
				792	"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.
				793	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				794	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				795	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				796	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				797	{
				798	"message": "A String", # [Output Only] A human-readable description of the warning code.
				799	"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.
				800	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				801	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				802	{
				803	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				804	"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).
				805	},
				806	],
				807	},
				808	],
				809	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				810	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				811	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				812	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	813	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	814	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				815	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				816	{
				817	"message": "A String", # [Output Only] An optional, human-readable error message.
				818	"code": "A String", # [Output Only] The error type identifier for this error.
				819	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				820	},
				821	],
				822	},
				823	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				824	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	825	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	826	}</pre>
				827	</div>
				828
				829	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	830	<code class="details" id="removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	831	<pre>Removes instance URL from a target pool.
				832
				833	Args:
				834	project: string, Project ID for this request. (required)
				835	region: string, Name of the region scoping this request. (required)
				836	targetPool: string, Name of the TargetPool resource to remove instances from. (required)
				837	body: object, The request body. (required)
				838	The object takes the form of:
				839
				840	{
				841	"instances": [ # URLs of the instances to be removed from target pool.
				842	{
				843	"instance": "A String", # The URL for a specific instance.
				844	},
				845	],
				846	}
				847
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	848	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.
				849
				850	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.
				851
				852	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]	853
				854	Returns:
				855	An object of the form:
				856
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	857	{ # Represents an Operation resource.
				858	#
				859	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				860	#
				861	# Operations can be global, regional or zonal.
				862	# - For global operations, use the globalOperations resource.
				863	# - For regional operations, use the regionOperations resource.
				864	# - For zonal operations, use the zonalOperations resource.
				865	#
				866	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	867	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	868	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	869	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	870	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	871	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	872	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				873	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				874	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				875	"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.
				876	"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.
				877	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				878	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				879	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				880	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				881	{
				882	"message": "A String", # [Output Only] A human-readable description of the warning code.
				883	"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.
				884	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				885	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				886	{
				887	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				888	"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).
				889	},
				890	],
				891	},
				892	],
				893	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				894	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				895	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				896	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	897	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	898	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				899	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				900	{
				901	"message": "A String", # [Output Only] An optional, human-readable error message.
				902	"code": "A String", # [Output Only] The error type identifier for this error.
				903	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				904	},
				905	],
				906	},
				907	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				908	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	909	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	910	}</pre>
				911	</div>
				912
				913	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	914	<code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	915	<pre>Changes a backup target pool's configurations.
				916
				917	Args:
				918	project: string, Project ID for this request. (required)
				919	region: string, Name of the region scoping this request. (required)
				920	targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
				921	body: object, The request body. (required)
				922	The object takes the form of:
				923
				924	{
				925	"target": "A String",
				926	}
				927
				928	failoverRatio: number, New failoverRatio value for the target pool.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	929	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.
				930
				931	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.
				932
				933	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]	934
				935	Returns:
				936	An object of the form:
				937
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	938	{ # Represents an Operation resource.
				939	#
				940	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				941	#
				942	# Operations can be global, regional or zonal.
				943	# - For global operations, use the globalOperations resource.
				944	# - For regional operations, use the regionOperations resource.
				945	# - For zonal operations, use the zonalOperations resource.
				946	#
				947	# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	948	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	949	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	950	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	951	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	952	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	953	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				954	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				955	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				956	"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.
				957	"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.
				958	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				959	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				960	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				961	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				962	{
				963	"message": "A String", # [Output Only] A human-readable description of the warning code.
				964	"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.
				965	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				966	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				967	{
				968	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				969	"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).
				970	},
				971	],
				972	},
				973	],
				974	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				975	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				976	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				977	"name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	978	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	979	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				980	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				981	{
				982	"message": "A String", # [Output Only] An optional, human-readable error message.
				983	"code": "A String", # [Output Only] The error type identifier for this error.
				984	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				985	},
				986	],
				987	},
				988	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				989	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	990	"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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	991	}</pre>
				992	</div>
				993
				994	<div class="method">
				995	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
				996	<pre>Returns permissions that a caller has on the specified resource.
				997
				998	Args:
				999	project: string, Project ID for this request. (required)
				1000	region: string, The name of the region for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1001	resource: string, Name or id of the resource for this request. (required)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1002	body: object, The request body. (required)
				1003	The object takes the form of:
				1004
				1005	{
				1006	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				1007	"A String",
				1008	],
				1009	}
				1010
				1011
				1012	Returns:
				1013	An object of the form:
				1014
				1015	{
				1016	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				1017	"A String",
				1018	],
				1019	}</pre>
				1020	</div>
				1021
				1022	</body></html>