blob: 10626eec1d6f860f61ecbafb7b9d08d33c8c99f2 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetPools.html">targetPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040078 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070079<p class="firstline">Adds health check URLs to a target pool.</p>
80<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040081 <code><a href="#addInstance">addInstance(project, region, targetPool, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070082<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040090 <code><a href="#delete">delete(project, region, targetPool, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070091<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 Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Returns the specified target pool. Gets a list of available target pools by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070095<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040099 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700100<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400108 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700109<p class="firstline">Removes health check URL from a target pool.</p>
110<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400111 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700112<p class="firstline">Removes instance URL from a target pool.</p>
113<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400114 <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700115<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400121 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700122 <pre>Adds health check URLs to a target pool.
123
124Args:
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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400132 "healthChecks": [ # The HttpHealthCheck to add to the target pool.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700133 { # 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 Kim715bd7f2019-06-14 16:50:42 -0700142 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
144For 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
146The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700147
148Returns:
149 An object of the form:
150
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 { # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700161 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700162 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400163 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700164 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700165 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700166 "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 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700188 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
189 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
190 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
191 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700193 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
194 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
195 {
196 "message": "A String", # [Output Only] An optional, human-readable error message.
197 "code": "A String", # [Output Only] The error type identifier for this error.
198 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
199 },
200 ],
201 },
202 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800204 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700205 }</pre>
206</div>
207
208<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400209 <code class="details" id="addInstance">addInstance(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700210 <pre>Adds an instance to a target pool.
211
212Args:
213 project: string, Project ID for this request. (required)
214 region: string, Name of the region scoping this request. (required)
215 targetPool: string, Name of the TargetPool resource to add instances to. (required)
216 body: object, The request body. (required)
217 The object takes the form of:
218
219{
220 "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:
221 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
222 # - projects/project-id/zones/zone/instances/instance-name
223 # - zones/zone/instances/instance-name
224 {
225 "instance": "A String", # The URL for a specific instance.
226 },
227 ],
228 }
229
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700230 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.
231
232For 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.
233
234The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700235
236Returns:
237 An object of the form:
238
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239 { # Represents an Operation resource.
240 #
241 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
242 #
243 # Operations can be global, regional or zonal.
244 # - For global operations, use the globalOperations resource.
245 # - For regional operations, use the regionOperations resource.
246 # - For zonal operations, use the zonalOperations resource.
247 #
248 # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700249 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700250 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400251 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700252 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700253 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700254 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
255 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
256 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
257 "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.
258 "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.
259 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
260 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
261 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
262 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
263 {
264 "message": "A String", # [Output Only] A human-readable description of the warning code.
265 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
266 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
267 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
268 {
269 "value": "A String", # [Output Only] A warning data value corresponding to the key.
270 "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).
271 },
272 ],
273 },
274 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700275 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700276 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
277 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
278 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
279 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700281 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
282 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
283 {
284 "message": "A String", # [Output Only] An optional, human-readable error message.
285 "code": "A String", # [Output Only] The error type identifier for this error.
286 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
287 },
288 ],
289 },
290 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
291 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800292 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
298 <pre>Retrieves an aggregated list of target pools.
299
300Args:
301 project: string, Project ID for this request. (required)
302 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
303
304You 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.
305
306Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400307 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 Cheemalapatidf613972016-10-21 13:59:49 -0700308 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 Kim715bd7f2019-06-14 16:50:42 -0700309 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 Cheemalapatidf613972016-10-21 13:59:49 -0700310
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700311For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700312
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313You 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 Cheemalapatidf613972016-10-21 13:59:49 -0700314
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700315To 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 Cheemalapatidf613972016-10-21 13:59:49 -0700316
317Returns:
318 An object of the form:
319
320 {
321 "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 Kim715bd7f2019-06-14 16:50:42 -0700322 "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
323 "items": { # A list of TargetPool resources.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700324 "a_key": { # Name of the scope containing this set of target pools.
325 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
326 "message": "A String", # [Output Only] A human-readable description of the warning code.
327 "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.
328 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
329 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
330 {
331 "value": "A String", # [Output Only] A warning data value corresponding to the key.
332 "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).
333 },
334 ],
335 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700336 "targetPools": [ # A list of target pools contained in this scope.
337 { # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700338 "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].
339 #
340 # 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.
341 #
342 # 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.
343 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
344 "region": "A String", # [Output Only] URL of the region where the target pool resides.
345 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700346 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700347 "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.
348 "A String",
349 ],
350 "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].
351 #
352 # 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.
353 #
354 # 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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400355 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700356 "A String",
357 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
359 # NONE: Connections from the same client IP may go to any instance in the pool.
360 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
361 # 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700362 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
363 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
364 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700365 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700366 },
367 ],
368 },
369 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 "warning": { # [Output Only] Informational warning message.
371 "message": "A String", # [Output Only] A human-readable description of the warning code.
372 "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.
373 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
374 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
375 {
376 "value": "A String", # [Output Only] A warning data value corresponding to the key.
377 "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).
378 },
379 ],
380 },
381 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700382 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
383 }</pre>
384</div>
385
386<div class="method">
387 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
388 <pre>Retrieves the next page of results.
389
390Args:
391 previous_request: The request for the previous page. (required)
392 previous_response: The response from the request for the previous page. (required)
393
394Returns:
395 A request object that you can call 'execute()' on to request the next
396 page. Returns None if there are no more items in the collection.
397 </pre>
398</div>
399
400<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400401 <code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700402 <pre>Deletes the specified target pool.
403
404Args:
405 project: string, Project ID for this request. (required)
406 region: string, Name of the region scoping this request. (required)
407 targetPool: string, Name of the TargetPool resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700408 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.
409
410For 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.
411
412The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700413
414Returns:
415 An object of the form:
416
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700417 { # Represents an Operation resource.
418 #
419 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
420 #
421 # Operations can be global, regional or zonal.
422 # - For global operations, use the globalOperations resource.
423 # - For regional operations, use the regionOperations resource.
424 # - For zonal operations, use the zonalOperations resource.
425 #
426 # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700427 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700428 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400429 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700430 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700431 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700432 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
433 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
434 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
435 "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.
436 "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.
437 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
438 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
439 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
440 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
441 {
442 "message": "A String", # [Output Only] A human-readable description of the warning code.
443 "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.
444 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
445 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
446 {
447 "value": "A String", # [Output Only] A warning data value corresponding to the key.
448 "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).
449 },
450 ],
451 },
452 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700453 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700454 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
455 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
456 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
457 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700459 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
460 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
461 {
462 "message": "A String", # [Output Only] An optional, human-readable error message.
463 "code": "A String", # [Output Only] The error type identifier for this error.
464 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
465 },
466 ],
467 },
468 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
469 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800470 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700471 }</pre>
472</div>
473
474<div class="method">
475 <code class="details" id="get">get(project, region, targetPool)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700476 <pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700477
478Args:
479 project: string, Project ID for this request. (required)
480 region: string, Name of the region scoping this request. (required)
481 targetPool: string, Name of the TargetPool resource to return. (required)
482
483Returns:
484 An object of the form:
485
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700486 { # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700487 "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].
488 #
489 # 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.
490 #
491 # 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.
492 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
493 "region": "A String", # [Output Only] URL of the region where the target pool resides.
494 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700495 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700496 "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.
497 "A String",
498 ],
499 "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].
500 #
501 # 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.
502 #
503 # 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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400504 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700505 "A String",
506 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700507 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
508 # NONE: Connections from the same client IP may go to any instance in the pool.
509 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
510 # 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700511 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
512 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
513 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700514 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700515 }</pre>
516</div>
517
518<div class="method">
519 <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
520 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
521
522Args:
523 project: string, Project ID for this request. (required)
524 region: string, Name of the region scoping this request. (required)
525 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
526 body: object, The request body. (required)
527 The object takes the form of:
528
529{
530 "instance": "A String", # The URL for a specific instance.
531}
532
533
534Returns:
535 An object of the form:
536
537 {
538 "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
539 "healthStatus": [
540 {
541 "instance": "A String", # URL of the instance resource.
542 "healthState": "A String", # Health state of the instance.
543 "ipAddress": "A String", # The IP address represented by this resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700544 "annotations": { # Metadata defined as annotations for network endpoint.
545 "a_key": "A String",
546 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700547 "port": 42, # The port on the instance.
548 },
549 ],
550 }</pre>
551</div>
552
553<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400554 <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700555 <pre>Creates a target pool in the specified project and region using the data included in the request.
556
557Args:
558 project: string, Project ID for this request. (required)
559 region: string, Name of the region scoping this request. (required)
560 body: object, The request body. (required)
561 The object takes the form of:
562
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700563{ # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700564 "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].
565 #
566 # 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.
567 #
568 # 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.
569 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
570 "region": "A String", # [Output Only] URL of the region where the target pool resides.
571 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700572 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700573 "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.
574 "A String",
575 ],
576 "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].
577 #
578 # 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.
579 #
580 # 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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400581 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700582 "A String",
583 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700584 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
585 # NONE: Connections from the same client IP may go to any instance in the pool.
586 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
587 # 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700588 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
589 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
590 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700591 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700592 }
593
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700594 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.
595
596For 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.
597
598The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700599
600Returns:
601 An object of the form:
602
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700603 { # Represents an Operation resource.
604 #
605 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
606 #
607 # Operations can be global, regional or zonal.
608 # - For global operations, use the globalOperations resource.
609 # - For regional operations, use the regionOperations resource.
610 # - For zonal operations, use the zonalOperations resource.
611 #
612 # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700613 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700614 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400615 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700616 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700617 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700618 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
619 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
620 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
621 "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.
622 "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.
623 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
624 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
625 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
626 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
627 {
628 "message": "A String", # [Output Only] A human-readable description of the warning code.
629 "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.
630 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
631 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
632 {
633 "value": "A String", # [Output Only] A warning data value corresponding to the key.
634 "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).
635 },
636 ],
637 },
638 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700639 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700640 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
641 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
642 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
643 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700644 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700645 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
646 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
647 {
648 "message": "A String", # [Output Only] An optional, human-readable error message.
649 "code": "A String", # [Output Only] The error type identifier for this error.
650 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
651 },
652 ],
653 },
654 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
655 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800656 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700657 }</pre>
658</div>
659
660<div class="method">
661 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
662 <pre>Retrieves a list of target pools available to the specified project and region.
663
664Args:
665 project: string, Project ID for this request. (required)
666 region: string, Name of the region scoping this request. (required)
667 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
668
669You 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.
670
671Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400672 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 Cheemalapatidf613972016-10-21 13:59:49 -0700673 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 Kim715bd7f2019-06-14 16:50:42 -0700674 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 Cheemalapatidf613972016-10-21 13:59:49 -0700675
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700676For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700677
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700678You 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 Cheemalapatidf613972016-10-21 13:59:49 -0700679
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700680To 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 Cheemalapatidf613972016-10-21 13:59:49 -0700681
682Returns:
683 An object of the form:
684
685 { # Contains a list of TargetPool resources.
686 "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 Kim715bd7f2019-06-14 16:50:42 -0700687 "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700688 "items": [ # A list of TargetPool resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700689 { # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700690 "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].
691 #
692 # 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.
693 #
694 # 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.
695 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
696 "region": "A String", # [Output Only] URL of the region where the target pool resides.
697 "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700698 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700699 "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.
700 "A String",
701 ],
702 "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].
703 #
704 # 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.
705 #
706 # 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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400707 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700708 "A String",
709 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700710 "sessionAffinity": "A String", # Session affinity option, must be one of the following values:
711 # NONE: Connections from the same client IP may go to any instance in the pool.
712 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
713 # 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700714 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
715 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
716 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700717 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700718 },
719 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700720 "warning": { # [Output Only] Informational warning message.
721 "message": "A String", # [Output Only] A human-readable description of the warning code.
722 "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.
723 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
724 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
725 {
726 "value": "A String", # [Output Only] A warning data value corresponding to the key.
727 "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).
728 },
729 ],
730 },
731 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700732 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
733 }</pre>
734</div>
735
736<div class="method">
737 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
738 <pre>Retrieves the next page of results.
739
740Args:
741 previous_request: The request for the previous page. (required)
742 previous_response: The response from the request for the previous page. (required)
743
744Returns:
745 A request object that you can call 'execute()' on to request the next
746 page. Returns None if there are no more items in the collection.
747 </pre>
748</div>
749
750<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400751 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700752 <pre>Removes health check URL from a target pool.
753
754Args:
755 project: string, Project ID for this request. (required)
756 region: string, Name of the region for this request. (required)
757 targetPool: string, Name of the target pool to remove health checks from. (required)
758 body: object, The request body. (required)
759 The object takes the form of:
760
761{
762 "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
763 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
764 # - projects/project/global/httpHealthChecks/health-check
765 # - global/httpHealthChecks/health-check
766 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
767 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
768 # - projects/project-id/global/httpHealthChecks/health-check
769 # - global/httpHealthChecks/health-check
770 "healthCheck": "A String",
771 },
772 ],
773 }
774
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700775 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
776
777For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
778
779The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700780
781Returns:
782 An object of the form:
783
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700784 { # Represents an Operation resource.
785 #
786 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
787 #
788 # Operations can be global, regional or zonal.
789 # - For global operations, use the globalOperations resource.
790 # - For regional operations, use the regionOperations resource.
791 # - For zonal operations, use the zonalOperations resource.
792 #
793 # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700794 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700795 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400796 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700797 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700798 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700799 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
800 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
801 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
802 "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.
803 "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.
804 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
805 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
806 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
807 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
808 {
809 "message": "A String", # [Output Only] A human-readable description of the warning code.
810 "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.
811 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
812 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
813 {
814 "value": "A String", # [Output Only] A warning data value corresponding to the key.
815 "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).
816 },
817 ],
818 },
819 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700820 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700821 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
822 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
823 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
824 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700825 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700826 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
827 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
828 {
829 "message": "A String", # [Output Only] An optional, human-readable error message.
830 "code": "A String", # [Output Only] The error type identifier for this error.
831 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
832 },
833 ],
834 },
835 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
836 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800837 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700838 }</pre>
839</div>
840
841<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400842 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700843 <pre>Removes instance URL from a target pool.
844
845Args:
846 project: string, Project ID for this request. (required)
847 region: string, Name of the region scoping this request. (required)
848 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
849 body: object, The request body. (required)
850 The object takes the form of:
851
852{
853 "instances": [ # URLs of the instances to be removed from target pool.
854 {
855 "instance": "A String", # The URL for a specific instance.
856 },
857 ],
858 }
859
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700860 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.
861
862For 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.
863
864The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700865
866Returns:
867 An object of the form:
868
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700869 { # Represents an Operation resource.
870 #
871 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
872 #
873 # Operations can be global, regional or zonal.
874 # - For global operations, use the globalOperations resource.
875 # - For regional operations, use the regionOperations resource.
876 # - For zonal operations, use the zonalOperations resource.
877 #
878 # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700879 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700880 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400881 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700882 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700883 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700884 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
885 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
886 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
887 "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.
888 "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.
889 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
890 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
891 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
892 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
893 {
894 "message": "A String", # [Output Only] A human-readable description of the warning code.
895 "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.
896 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
897 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
898 {
899 "value": "A String", # [Output Only] A warning data value corresponding to the key.
900 "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).
901 },
902 ],
903 },
904 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700905 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700906 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
907 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
908 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
909 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700910 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700911 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
912 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
913 {
914 "message": "A String", # [Output Only] An optional, human-readable error message.
915 "code": "A String", # [Output Only] The error type identifier for this error.
916 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
917 },
918 ],
919 },
920 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
921 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800922 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700923 }</pre>
924</div>
925
926<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400927 <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700928 <pre>Changes a backup target pool's configurations.
929
930Args:
931 project: string, Project ID for this request. (required)
932 region: string, Name of the region scoping this request. (required)
933 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
934 body: object, The request body. (required)
935 The object takes the form of:
936
937{
938 "target": "A String",
939 }
940
941 failoverRatio: number, New failoverRatio value for the target pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700942 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.
943
944For 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.
945
946The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700947
948Returns:
949 An object of the form:
950
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700951 { # Represents an Operation resource.
952 #
953 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
954 #
955 # Operations can be global, regional or zonal.
956 # - For global operations, use the globalOperations resource.
957 # - For regional operations, use the regionOperations resource.
958 # - For zonal operations, use the zonalOperations resource.
959 #
960 # 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 Cheemalapatidf613972016-10-21 13:59:49 -0700961 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700962 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400963 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700964 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700965 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700966 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
967 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
968 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
969 "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.
970 "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.
971 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
972 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
973 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
974 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
975 {
976 "message": "A String", # [Output Only] A human-readable description of the warning code.
977 "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.
978 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
979 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
980 {
981 "value": "A String", # [Output Only] A warning data value corresponding to the key.
982 "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).
983 },
984 ],
985 },
986 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700987 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700988 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
989 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
990 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
991 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700992 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700993 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
994 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
995 {
996 "message": "A String", # [Output Only] An optional, human-readable error message.
997 "code": "A String", # [Output Only] The error type identifier for this error.
998 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
999 },
1000 ],
1001 },
1002 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1003 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001004 "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 Cheemalapatidf613972016-10-21 13:59:49 -07001005 }</pre>
1006</div>
1007
1008<div class="method">
1009 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
1010 <pre>Returns permissions that a caller has on the specified resource.
1011
1012Args:
1013 project: string, Project ID for this request. (required)
1014 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001015 resource: string, Name or id of the resource for this request. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001016 body: object, The request body. (required)
1017 The object takes the form of:
1018
1019{
1020 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
1021 "A String",
1022 ],
1023 }
1024
1025
1026Returns:
1027 An object of the form:
1028
1029 {
1030 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1031 "A String",
1032 ],
1033 }</pre>
1034</div>
1035
1036</body></html>