blob: 3feedb4e04c15fa9a63ebef246b4cf3710d1835f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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_v1.html">Compute Engine API</a> . <a href="compute_v1.targetPools.html">targetPools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080079<p class="firstline">Adds health check URLs to a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#addInstance">addInstance(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080082<p class="firstline">Adds an instance to a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080085<p class="firstline">Retrieves an aggregated list of target pools.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
87 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090 <code><a href="#close">close()</a></code></p>
91<p class="firstline">Close httplib2 connections.</p>
92<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070093 <code><a href="#delete">delete(project, region, targetPool, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080094<p class="firstline">Deletes the specified target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<p class="toc_element">
96 <code><a href="#get">get(project, region, targetPool)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Returns the specified target pool. Gets a list of available target pools by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -040098<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#getHealth">getHealth(project, region, targetPool, body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100<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>
John Asmuth614db982014-04-24 15:46:26 -0400101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800103<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400104<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800106<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>
John Asmuth614db982014-04-24 15:46:26 -0400107<p class="toc_element">
108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
109<p class="firstline">Retrieves the next page of results.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800112<p class="firstline">Removes health check URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800115<p class="firstline">Removes instance URL from a target pool.</p>
John Asmuth614db982014-04-24 15:46:26 -0400116<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700117 <code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800118<p class="firstline">Changes a backup target pool's configurations.</p>
John Asmuth614db982014-04-24 15:46:26 -0400119<h3>Method Details</h3>
120<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700121 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800122 <pre>Adds health check URLs to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400123
124Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800125 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400126 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800127 targetPool: string, Name of the target pool to add a health check to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400129 The object takes the form of:
130
131{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800132 &quot;healthChecks&quot;: [ # The HttpHealthCheck to add to the target pool.
133 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
134 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
135 # - projects/project-id/global/httpHealthChecks/health-check
136 # - global/httpHealthChecks/health-check
137 &quot;healthCheck&quot;: &quot;A String&quot;,
138 },
139 ],
140}
John Asmuth614db982014-04-24 15:46:26 -0400141
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).
John Asmuth614db982014-04-24 15:46:26 -0400147
148Returns:
149 An object of the form:
150
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800152 #
153 # Google Compute Engine has three Operation resources:
154 #
155 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
156 #
157 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
158 #
159 # Operations can be global, regional or zonal.
160 # - For global operations, use the `globalOperations` resource.
161 # - For regional operations, use the `regionOperations` resource.
162 # - For zonal operations, use the `zonalOperations` resource.
163 #
164 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
165 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
166 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
167 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
168 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
169 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
170 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700171 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800172 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
173 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
174 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700175 },
176 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800177 },
178 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
179 &quot;httpErrorStatusCode&quot;: 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.
180 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
181 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
182 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
183 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800184 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800185 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
186 &quot;progress&quot;: 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.
187 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
188 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
189 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
190 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
191 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
192 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
193 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
194 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
195 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
196 {
197 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
198 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
199 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
200 {
201 &quot;key&quot;: &quot;A String&quot;, # [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).
202 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
203 },
204 ],
205 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
206 },
207 ],
208 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
209}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400210</div>
211
212<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700213 <code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800214 <pre>Adds an instance to a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400215
216Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800217 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400218 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800219 targetPool: string, Name of the TargetPool resource to add instances to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700220 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400221 The object takes the form of:
222
223{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800224 &quot;instances&quot;: [ # 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:
225 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
226 # - projects/project-id/zones/zone/instances/instance-name
227 # - zones/zone/instances/instance-name
228 {
229 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
230 },
231 ],
232}
John Asmuth614db982014-04-24 15:46:26 -0400233
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700234 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.
235
236For 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.
237
238The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400239
240Returns:
241 An object of the form:
242
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800244 #
245 # Google Compute Engine has three Operation resources:
246 #
247 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
248 #
249 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
250 #
251 # Operations can be global, regional or zonal.
252 # - For global operations, use the `globalOperations` resource.
253 # - For regional operations, use the `regionOperations` resource.
254 # - For zonal operations, use the `zonalOperations` resource.
255 #
256 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
257 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
258 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
259 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
260 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
261 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
262 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800264 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
265 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
266 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 },
268 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800269 },
270 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
271 &quot;httpErrorStatusCode&quot;: 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.
272 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
273 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
274 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
275 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800276 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800277 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
278 &quot;progress&quot;: 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.
279 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
280 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
281 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
282 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
283 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
284 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
285 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
286 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
287 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
288 {
289 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
290 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
291 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
292 {
293 &quot;key&quot;: &quot;A String&quot;, # [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).
294 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
295 },
296 ],
297 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
298 },
299 ],
300 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
301}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400302</div>
303
304<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700305 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800306 <pre>Retrieves an aggregated list of target pools.
John Asmuth614db982014-04-24 15:46:26 -0400307
308Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800309 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700310 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 `=`, `!=`, `&gt;`, or `&lt;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700311
Dan O'Mearadd494642020-05-01 07:42:23 -0700312For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700313
Dan O'Mearadd494642020-05-01 07:42:23 -0700314You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800315
Bu Sun Kim65020912020-05-20 12:08:20 -0700316To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700317 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700318 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`)
319 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
320
321You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
322
323Currently, only sorting by `name` or `creationTimestamp desc` is supported.
324 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800325 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
John Asmuth614db982014-04-24 15:46:26 -0400326
327Returns:
328 An object of the form:
329
330 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800331 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
332 &quot;items&quot;: { # A list of TargetPool resources.
333 &quot;a_key&quot;: { # Name of the scope containing this set of target pools.
334 &quot;targetPools&quot;: [ # A list of target pools contained in this scope.
335 { # Represents a Target Pool resource.
336 #
337 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
338 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Bu Sun Kim65020912020-05-20 12:08:20 -0700339 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800340 # 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.
341 #
342 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
343 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
344 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
345 &quot;failoverRatio&quot;: 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].
346 #
347 # 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.
348 #
349 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800350 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800351 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400352 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800353 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
354 &quot;instances&quot;: [ # 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.
355 &quot;A String&quot;,
356 ],
357 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
358 &quot;name&quot;: &quot;A String&quot;, # 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.
359 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
360 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
361 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
362 # NONE: Connections from the same client IP may go to any instance in the pool.
363 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
364 # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700365 },
366 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800367 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when the list is empty.
368 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
369 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
370 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
371 {
372 &quot;key&quot;: &quot;A String&quot;, # [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).
373 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
374 },
375 ],
376 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
377 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700378 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800379 },
380 &quot;kind&quot;: &quot;compute#targetPoolAggregatedList&quot;, # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
381 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
382 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
383 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
384 &quot;A String&quot;,
385 ],
386 &quot;warning&quot;: { # [Output Only] Informational warning message.
387 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
388 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
389 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
390 {
391 &quot;key&quot;: &quot;A String&quot;, # [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).
392 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
393 },
394 ],
395 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
396 },
397}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400398</div>
399
400<div class="method">
401 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
402 <pre>Retrieves the next page of results.
403
404Args:
405 previous_request: The request for the previous page. (required)
406 previous_response: The response from the request for the previous page. (required)
407
408Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700409 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400410 page. Returns None if there are no more items in the collection.
411 </pre>
412</div>
413
414<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700415 <code class="details" id="close">close()</code>
416 <pre>Close httplib2 connections.</pre>
417</div>
418
419<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700420 <code class="details" id="delete">delete(project, region, targetPool, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800421 <pre>Deletes the specified target pool.
John Asmuth614db982014-04-24 15:46:26 -0400422
423Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800424 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400425 region: string, Name of the region scoping this request. (required)
426 targetPool: string, Name of the TargetPool resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427 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.
428
429For 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.
430
431The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400432
433Returns:
434 An object of the form:
435
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700436 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800437 #
438 # Google Compute Engine has three Operation resources:
439 #
440 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
441 #
442 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
443 #
444 # Operations can be global, regional or zonal.
445 # - For global operations, use the `globalOperations` resource.
446 # - For regional operations, use the `regionOperations` resource.
447 # - For zonal operations, use the `zonalOperations` resource.
448 #
449 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
450 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
451 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
452 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
453 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
454 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
455 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700456 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800457 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
458 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
459 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700460 },
461 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800462 },
463 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
464 &quot;httpErrorStatusCode&quot;: 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.
465 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
466 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
467 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
468 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800469 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800470 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
471 &quot;progress&quot;: 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.
472 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
473 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
474 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
475 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
476 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
477 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
478 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
479 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
480 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
481 {
482 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
483 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
484 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
485 {
486 &quot;key&quot;: &quot;A String&quot;, # [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).
487 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
488 },
489 ],
490 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
491 },
492 ],
493 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
494}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400495</div>
496
497<div class="method">
498 <code class="details" id="get">get(project, region, targetPool)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700499 <pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400500
501Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800502 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400503 region: string, Name of the region scoping this request. (required)
504 targetPool: string, Name of the TargetPool resource to return. (required)
505
506Returns:
507 An object of the form:
508
Dan O'Mearadd494642020-05-01 07:42:23 -0700509 { # Represents a Target Pool resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800510 #
511 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
512 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Bu Sun Kim65020912020-05-20 12:08:20 -0700513 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800514 # 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.
515 #
516 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
517 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
518 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
519 &quot;failoverRatio&quot;: 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].
520 #
521 # 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.
522 #
523 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800524 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800525 &quot;A String&quot;,
526 ],
527 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
528 &quot;instances&quot;: [ # 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.
529 &quot;A String&quot;,
530 ],
531 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
532 &quot;name&quot;: &quot;A String&quot;, # 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.
533 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
534 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
535 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
536 # NONE: Connections from the same client IP may go to any instance in the pool.
537 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
538 # 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.
539}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400540</div>
541
542<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700543 <code class="details" id="getHealth">getHealth(project, region, targetPool, body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800544 <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
John Asmuth614db982014-04-24 15:46:26 -0400545
546Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800547 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400548 region: string, Name of the region scoping this request. (required)
549 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700550 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400551 The object takes the form of:
552
553{
Bu Sun Kim65020912020-05-20 12:08:20 -0700554 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
John Asmuth614db982014-04-24 15:46:26 -0400555}
556
557
558Returns:
559 An object of the form:
560
561 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800562 &quot;healthStatus&quot;: [
563 {
564 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
565 &quot;a_key&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400566 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400567 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the instance.
568 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800569 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the instance.
570 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800571 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding rule&#x27;s IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800572 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is health-checked.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800573 &quot;weight&quot;: &quot;A String&quot;,
574 &quot;weightError&quot;: &quot;A String&quot;,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800575 },
576 ],
577 &quot;kind&quot;: &quot;compute#targetPoolInstanceHealth&quot;, # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
578}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400579</div>
580
581<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700582 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800583 <pre>Creates a target pool in the specified project and region using the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400584
585Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800586 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400587 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700588 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400589 The object takes the form of:
590
Dan O'Mearadd494642020-05-01 07:42:23 -0700591{ # Represents a Target Pool resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700592 #
593 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700594 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Dan O'Mearadd494642020-05-01 07:42:23 -0700595 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700596 # 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.
597 #
598 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
599 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
600 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
601 &quot;failoverRatio&quot;: 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].
602 #
603 # 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.
604 #
605 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800606 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700607 &quot;A String&quot;,
608 ],
609 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
610 &quot;instances&quot;: [ # 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.
611 &quot;A String&quot;,
612 ],
613 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
614 &quot;name&quot;: &quot;A String&quot;, # 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.
615 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
616 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
617 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
618 # NONE: Connections from the same client IP may go to any instance in the pool.
619 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
620 # 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.
621}
John Asmuth614db982014-04-24 15:46:26 -0400622
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700623 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.
624
625For 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.
626
627The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400628
629Returns:
630 An object of the form:
631
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700632 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800633 #
634 # Google Compute Engine has three Operation resources:
635 #
636 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
637 #
638 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
639 #
640 # Operations can be global, regional or zonal.
641 # - For global operations, use the `globalOperations` resource.
642 # - For regional operations, use the `regionOperations` resource.
643 # - For zonal operations, use the `zonalOperations` resource.
644 #
645 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
646 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
647 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
648 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
649 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
650 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
651 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700652 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800653 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
654 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
655 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700656 },
657 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800658 },
659 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
660 &quot;httpErrorStatusCode&quot;: 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.
661 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
662 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
663 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
664 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800665 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800666 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
667 &quot;progress&quot;: 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.
668 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
669 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
670 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
671 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
672 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
673 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
674 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
675 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
676 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
677 {
678 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
679 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
680 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
681 {
682 &quot;key&quot;: &quot;A String&quot;, # [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).
683 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
684 },
685 ],
686 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
687 },
688 ],
689 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
690}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400691</div>
692
693<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700694 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800695 <pre>Retrieves a list of target pools available to the specified project and region.
John Asmuth614db982014-04-24 15:46:26 -0400696
697Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800698 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400699 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700700 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 `=`, `!=`, `&gt;`, or `&lt;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700701
Dan O'Mearadd494642020-05-01 07:42:23 -0700702For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700703
Dan O'Mearadd494642020-05-01 07:42:23 -0700704You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800705
Bu Sun Kim65020912020-05-20 12:08:20 -0700706To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
707 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`)
708 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
709
710You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
711
712Currently, only sorting by `name` or `creationTimestamp desc` is supported.
713 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800714 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
John Asmuth614db982014-04-24 15:46:26 -0400715
716Returns:
717 An object of the form:
718
719 { # Contains a list of TargetPool resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800720 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
721 &quot;items&quot;: [ # A list of TargetPool resources.
722 { # Represents a Target Pool resource.
723 #
724 # Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
725 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Bu Sun Kim65020912020-05-20 12:08:20 -0700726 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800727 # 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.
728 #
729 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
730 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
731 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
732 &quot;failoverRatio&quot;: 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].
733 #
734 # 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.
735 #
736 # 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 &quot;force&quot; mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800737 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800738 &quot;A String&quot;,
739 ],
740 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
741 &quot;instances&quot;: [ # 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.
742 &quot;A String&quot;,
743 ],
744 &quot;kind&quot;: &quot;compute#targetPool&quot;, # [Output Only] Type of the resource. Always compute#targetPool for target pools.
745 &quot;name&quot;: &quot;A String&quot;, # 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.
746 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the target pool resides.
747 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
748 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
749 # NONE: Connections from the same client IP may go to any instance in the pool.
750 # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
751 # 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.
752 },
753 ],
754 &quot;kind&quot;: &quot;compute#targetPoolList&quot;, # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
755 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
756 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
757 &quot;warning&quot;: { # [Output Only] Informational warning message.
758 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
759 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
760 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
761 {
762 &quot;key&quot;: &quot;A String&quot;, # [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).
763 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim65020912020-05-20 12:08:20 -0700764 },
John Asmuth614db982014-04-24 15:46:26 -0400765 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800766 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
767 },
768}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400769</div>
770
771<div class="method">
772 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
773 <pre>Retrieves the next page of results.
774
775Args:
776 previous_request: The request for the previous page. (required)
777 previous_response: The response from the request for the previous page. (required)
778
779Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700780 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400781 page. Returns None if there are no more items in the collection.
782 </pre>
783</div>
784
785<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700786 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800787 <pre>Removes health check URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400788
789Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800790 project: string, Project ID for this request. (required)
791 region: string, Name of the region for this request. (required)
792 targetPool: string, Name of the target pool to remove health checks from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700793 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400794 The object takes the form of:
795
796{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800797 &quot;healthChecks&quot;: [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
798 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
799 # - projects/project/global/httpHealthChecks/health-check
800 # - global/httpHealthChecks/health-check
801 { # A full or valid partial URL to a health check. For example, the following are valid URLs:
802 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
803 # - projects/project-id/global/httpHealthChecks/health-check
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800804 # - global/httpHealthChecks/health-check
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800805 &quot;healthCheck&quot;: &quot;A String&quot;,
806 },
807 ],
808}
John Asmuth614db982014-04-24 15:46:26 -0400809
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700810 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.
811
812For 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.
813
814The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400815
816Returns:
817 An object of the form:
818
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700819 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800820 #
821 # Google Compute Engine has three Operation resources:
822 #
823 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
824 #
825 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
826 #
827 # Operations can be global, regional or zonal.
828 # - For global operations, use the `globalOperations` resource.
829 # - For regional operations, use the `regionOperations` resource.
830 # - For zonal operations, use the `zonalOperations` resource.
831 #
832 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
833 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
834 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
835 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
836 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
837 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
838 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700839 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800840 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
841 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
842 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700843 },
844 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800845 },
846 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
847 &quot;httpErrorStatusCode&quot;: 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.
848 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
849 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
850 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
851 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800852 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800853 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
854 &quot;progress&quot;: 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.
855 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
856 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
857 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
858 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
859 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
860 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
861 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
862 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
863 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
864 {
865 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
866 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
867 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
868 {
869 &quot;key&quot;: &quot;A String&quot;, # [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).
870 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
871 },
872 ],
873 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
874 },
875 ],
876 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
877}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400878</div>
879
880<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700881 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800882 <pre>Removes instance URL from a target pool.
John Asmuth614db982014-04-24 15:46:26 -0400883
884Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800885 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400886 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800887 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700888 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400889 The object takes the form of:
890
891{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800892 &quot;instances&quot;: [ # URLs of the instances to be removed from target pool.
893 {
894 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
895 },
896 ],
897}
John Asmuth614db982014-04-24 15:46:26 -0400898
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700899 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.
900
901For 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.
902
903The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400904
905Returns:
906 An object of the form:
907
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700908 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800909 #
910 # Google Compute Engine has three Operation resources:
911 #
912 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
913 #
914 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
915 #
916 # Operations can be global, regional or zonal.
917 # - For global operations, use the `globalOperations` resource.
918 # - For regional operations, use the `regionOperations` resource.
919 # - For zonal operations, use the `zonalOperations` resource.
920 #
921 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
922 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
923 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
924 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
925 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
926 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
927 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700928 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800929 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
930 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
931 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700932 },
933 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800934 },
935 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
936 &quot;httpErrorStatusCode&quot;: 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.
937 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
938 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
939 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
940 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800941 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800942 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
943 &quot;progress&quot;: 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.
944 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
945 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
946 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
947 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
948 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
949 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
950 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
951 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
952 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
953 {
954 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
955 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
956 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
957 {
958 &quot;key&quot;: &quot;A String&quot;, # [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).
959 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
960 },
961 ],
962 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
963 },
964 ],
965 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
966}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400967</div>
968
969<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700970 <code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700971 <pre>Changes a backup target pool&#x27;s configurations.
John Asmuth614db982014-04-24 15:46:26 -0400972
973Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800974 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400975 region: string, Name of the region scoping this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800976 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700977 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400978 The object takes the form of:
979
980{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800981 &quot;target&quot;: &quot;A String&quot;,
982}
John Asmuth614db982014-04-24 15:46:26 -0400983
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800984 failoverRatio: number, New failoverRatio value for the target pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700985 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.
986
987For 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.
988
989The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth614db982014-04-24 15:46:26 -0400990
991Returns:
992 An object of the form:
993
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700994 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800995 #
996 # Google Compute Engine has three Operation resources:
997 #
998 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
999 #
1000 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1001 #
1002 # Operations can be global, regional or zonal.
1003 # - For global operations, use the `globalOperations` resource.
1004 # - For regional operations, use the `regionOperations` resource.
1005 # - For zonal operations, use the `zonalOperations` resource.
1006 #
1007 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
1008 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1009 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1010 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1011 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1012 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1013 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -07001014 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001015 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1016 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1017 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -07001018 },
1019 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001020 },
1021 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1022 &quot;httpErrorStatusCode&quot;: 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.
1023 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1024 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1025 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1026 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -08001027 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001028 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1029 &quot;progress&quot;: 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.
1030 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1031 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1032 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1033 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1034 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1035 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1036 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
1037 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1038 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1039 {
1040 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1041 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1042 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
1043 {
1044 &quot;key&quot;: &quot;A String&quot;, # [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).
1045 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1046 },
1047 ],
1048 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1049 },
1050 ],
1051 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1052}</pre>
John Asmuth614db982014-04-24 15:46:26 -04001053</div>
1054
1055</body></html>