Debian Codegraph @

docs/dyn/compute_alpha.targetPools.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetPools.html">targetPools</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds health check URLs to a target pool.</p>
80 <p class="toc_element">
81 <code><a href="#addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Adds an instance to a target pool.</p>
83 <p class="toc_element">
84 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves an aggregated list of target pools.</p>
86 <p class="toc_element">
87 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <p class="toc_element">
90 <code><a href="#close">close()</a></code></p>
91 <p class="firstline">Close httplib2 connections.</p>
92 <p class="toc_element">
93 <code><a href="#delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes the specified target pool.</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, region, targetPool, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified target pool.</p>
98 <p class="toc_element">
99 <code><a href="#getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets the most recent health check results for each IP for the</p>
101 <p class="toc_element">
102 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Creates a target pool in the specified project and region using</p>
104 <p class="toc_element">
105 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves a list of target pools available to the specified</p>
107 <p class="toc_element">
108 <code><a href="#list_next">list_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Removes health check URL from a target pool.</p>
113 <p class="toc_element">
114 <code><a href="#removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Removes instance URL from a target pool.</p>
116 <p class="toc_element">
117 <code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Changes a backup target pool's configurations.</p>
119 <p class="toc_element">
120 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Sets the Google Cloud Armor security policy for the specified target pool.</p>
122 <p class="toc_element">
123 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
125 <h3>Method Details</h3>
126 <div class="method">
127 <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
128 <pre>Adds health check URLs to a target pool.
129
130 Args:
131 project: string, Project ID for this request. (required)
132 region: string, Name of the region scoping this request. (required)
133 targetPool: string, Name of the target pool to add a health check to. (required)
134 body: object, The request body.
135 The object takes the form of:
136
137 {
138 &quot;healthChecks&quot;: [ # The HttpHealthCheck to add to the target pool.
139 { # A full or valid partial URL to a health check. For example, the following are
140 # valid URLs:
141 #
142 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
143 # - projects/project-id/global/httpHealthChecks/health-check
144 # - global/httpHealthChecks/health-check
145 &quot;healthCheck&quot;: &quot;A String&quot;,
146 },
147 ],
148 }
149
150 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
151 that if you must retry your request, the server will know to ignore the
152 request if it has already been completed.
153
154 For example, consider a situation where you make an initial request and
155 the request times out. If you make the request again with the same
156 request ID, the server can check if original operation with the same
157 request ID was received, and if so, will ignore the second request. This
158 prevents clients from accidentally creating duplicate commitments.
159
160 The request ID must be
161 a valid UUID with the exception that zero UUID is not supported
162 (00000000-0000-0000-0000-000000000000).
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # Represents an Operation resource.
172 #
173 # Google Compute Engine has three Operation resources:
174 #
175 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
176 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
177 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
178 #
179 # You can use an operation resource to manage asynchronous API requests.
180 # For more information, readHandling
181 # API responses.
182 #
183 # Operations can be global, regional or zonal.
184 #
185 # - For global operations, use the `globalOperations`
186 # resource.
187 # - For regional operations, use the
188 # `regionOperations` resource.
189 # - For zonal operations, use
190 # the `zoneOperations` resource.
191 #
192 #
193 #
194 # For more information, read
195 # Global, Regional, and Zonal Resources.
196 #
197 # Note that completed Operation resources have a limited
198 # retention period.
199 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
200 # Not present otherwise.
201 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
202 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
203 # set when the operation is created.
204 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
205 # text format.
206 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
207 # this field will be populated.
208 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
209 # operation.
210 {
211 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
212 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
213 # details. There is a set of defined message types to use for providing
214 # details.The syntax depends on the error code. For example,
215 # QuotaExceededInfo will have details when the error code is
216 # QUOTA_EXCEEDED.
217 {
218 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
219 #
220 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
221 # is not enabled:
222 #
223 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
224 # &quot;domain&quot;: &quot;googleapis.com&quot;
225 # &quot;metadata&quot;: {
226 # &quot;resource&quot;: &quot;projects/123&quot;,
227 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
228 # }
229 # }
230 #
231 # This response indicates that the pubsub.googleapis.com API is not enabled.
232 #
233 # Example of an error that is returned when attempting to create a Spanner
234 # instance in a region that is out of stock:
235 #
236 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
237 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
238 # &quot;metadata&quot;: {
239 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
240 # }
241 # }
242 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
243 # is typically the registered service name of the tool or product that
244 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
245 # generated by some common infrastructure, the error domain must be a
246 # globally unique value that identifies the infrastructure. For Google API
247 # infrastructure, the error domain is &quot;googleapis.com&quot;.
248 &quot;metadatas&quot;: { # Additional structured details about this error.
249 #
250 # Keys must match a regular expression of `a-z+` but should
251 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
252 # length. When identifying the current value of an exceeded limit, the units
253 # should be contained in the key, not the value. For example, rather than
254 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
255 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
256 # instances that can be created in a single (batch) request.
257 &quot;a_key&quot;: &quot;A String&quot;,
258 },
259 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
260 # proximate cause of the error. Error reasons are unique within a particular
261 # domain of errors. This should be at most 63 characters and match a
262 # regular expression of `A-Z+[A-Z0-9]`, which represents
263 # UPPER_SNAKE_CASE.
264 },
265 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
266 #
267 # For example, if a quota check failed with an error indicating the calling
268 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
269 # directly to the right place in the developer console to flip the bit.
270 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
271 { # Describes a URL link.
272 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
273 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
274 },
275 ],
276 },
277 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
278 # which can be attached to an RPC error.
279 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
280 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
281 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
282 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
283 },
284 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
285 &quot;dimensions&quot;: { # The map holding related quota dimensions.
286 &quot;a_key&quot;: &quot;A String&quot;,
287 },
288 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
289 # type or metric.
290 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
291 # or metric.
292 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
293 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
294 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
295 },
296 },
297 ],
298 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
299 # This property is optional.
300 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
301 },
302 ],
303 },
304 &quot;getVersionOperationMetadata&quot;: {
305 &quot;inlineSbomInfo&quot;: {
306 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
307 # appropriate identifiers.
308 &quot;a_key&quot;: &quot;A String&quot;,
309 },
310 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
311 # identifiers.
312 &quot;a_key&quot;: &quot;A String&quot;,
313 },
314 },
315 },
316 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
317 # message that was returned, such as `NOT FOUND`.
318 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
319 # status code that was returned. For example, a `404` means the
320 # resource was not found.
321 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
322 # defined by the server.
323 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
324 # This value is inRFC3339
325 # text format.
326 &quot;instancesBulkInsertOperationMetadata&quot;: {
327 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
328 # Example key: zones/us-central1-a
329 &quot;a_key&quot;: {
330 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
331 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
332 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
333 # error.
334 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
335 # if the flow is rolling forward or rolling back.
336 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
337 },
338 },
339 },
340 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
341 # Operation resources.
342 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
343 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
344 # group of operations results from a `bulkInsert` API request.
345 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
346 # `update`, or `delete`, and so on.
347 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
348 # There is no requirement that this be linear or support any granularity of
349 # operations. This should not be used to guess when the operation will be
350 # complete. This number should monotonically increase as the operation
351 # progresses.
352 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
353 # applicable when performing regional operations.
354 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
355 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
356 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
357 # this field will contain information on all underlying zonal actions and
358 # their state.
359 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
360 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
361 # Example key: zones/us-central1-a
362 &quot;a_key&quot;: {
363 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
364 # populated.
365 # different programming environments, including REST APIs and RPC APIs. It is
366 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
367 # three pieces of data: error code, error message, and error details.
368 #
369 # You can find out more about this error model and how to work with it in the
370 # [API Design Guide](https://cloud.google.com/apis/design/errors).
371 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
372 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
373 # message types for APIs to use.
374 {
375 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
376 },
377 ],
378 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
379 # user-facing error message should be localized and sent in the
380 # google.rpc.Status.details field, or localized by the client.
381 },
382 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
383 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
384 },
385 },
386 },
387 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
388 # This value is inRFC3339
389 # text format.
390 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
391 # following:
392 # `PENDING`, `RUNNING`, or `DONE`.
393 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
394 # operation.
395 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
396 # of the target resource.
397 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
398 # operations related to creating a snapshot, this points to the disk
399 # that the snapshot was created from.
400 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
401 # `[email protected]` or
402 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
403 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
404 # operation, this field will be populated.
405 {
406 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
407 # Engine returns NO_RESULTS_ON_PAGE if there
408 # are no results in the response.
409 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
410 # value format. For example:
411 #
412 # &quot;data&quot;: [
413 # {
414 # &quot;key&quot;: &quot;scope&quot;,
415 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
416 # }
417 {
418 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
419 # returned. For example, for warnings where there are no results in a list
420 # request for a particular zone, this key might be scope and
421 # the key value might be the zone name. Other examples might be a key
422 # indicating a deprecated resource and a suggested replacement, or a
423 # warning about invalid network settings (for example, if an instance
424 # attempts to perform IP forwarding but is not enabled for IP forwarding).
425 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
426 },
427 ],
428 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
429 },
430 ],
431 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
432 # applicable when performing per-zone operations.
433 }</pre>
434 </div>
435
436 <div class="method">
437 <code class="details" id="addInstance">addInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
438 <pre>Adds an instance to a target pool.
439
440 Args:
441 project: string, Project ID for this request. (required)
442 region: string, Name of the region scoping this request. (required)
443 targetPool: string, Name of the TargetPool resource to add instances to. (required)
444 body: object, The request body.
445 The object takes the form of:
446
447 {
448 &quot;instances&quot;: [ # A full or partial URL to an instance to add to this target pool. This can
449 # be a full or partial URL. For example, the following are valid URLs:
450 #
451 # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
452 # - projects/project-id/zones/zone/instances/instance-name
453 # - zones/zone/instances/instance-name
454 {
455 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
456 # @required compute.instancegroups.addInstances/removeInstances
457 },
458 ],
459 }
460
461 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
462 that if you must retry your request, the server will know to ignore the
463 request if it has already been completed.
464
465 For example, consider a situation where you make an initial request and
466 the request times out. If you make the request again with the same
467 request ID, the server can check if original operation with the same
468 request ID was received, and if so, will ignore the second request. This
469 prevents clients from accidentally creating duplicate commitments.
470
471 The request ID must be
472 a valid UUID with the exception that zero UUID is not supported
473 (00000000-0000-0000-0000-000000000000).
474 x__xgafv: string, V1 error format.
475 Allowed values
476 1 - v1 error format
477 2 - v2 error format
478
479 Returns:
480 An object of the form:
481
482 { # Represents an Operation resource.
483 #
484 # Google Compute Engine has three Operation resources:
485 #
486 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
487 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
488 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
489 #
490 # You can use an operation resource to manage asynchronous API requests.
491 # For more information, readHandling
492 # API responses.
493 #
494 # Operations can be global, regional or zonal.
495 #
496 # - For global operations, use the `globalOperations`
497 # resource.
498 # - For regional operations, use the
499 # `regionOperations` resource.
500 # - For zonal operations, use
501 # the `zoneOperations` resource.
502 #
503 #
504 #
505 # For more information, read
506 # Global, Regional, and Zonal Resources.
507 #
508 # Note that completed Operation resources have a limited
509 # retention period.
510 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
511 # Not present otherwise.
512 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
513 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
514 # set when the operation is created.
515 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
516 # text format.
517 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
518 # this field will be populated.
519 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
520 # operation.
521 {
522 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
523 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
524 # details. There is a set of defined message types to use for providing
525 # details.The syntax depends on the error code. For example,
526 # QuotaExceededInfo will have details when the error code is
527 # QUOTA_EXCEEDED.
528 {
529 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
530 #
531 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
532 # is not enabled:
533 #
534 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
535 # &quot;domain&quot;: &quot;googleapis.com&quot;
536 # &quot;metadata&quot;: {
537 # &quot;resource&quot;: &quot;projects/123&quot;,
538 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
539 # }
540 # }
541 #
542 # This response indicates that the pubsub.googleapis.com API is not enabled.
543 #
544 # Example of an error that is returned when attempting to create a Spanner
545 # instance in a region that is out of stock:
546 #
547 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
548 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
549 # &quot;metadata&quot;: {
550 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
551 # }
552 # }
553 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
554 # is typically the registered service name of the tool or product that
555 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
556 # generated by some common infrastructure, the error domain must be a
557 # globally unique value that identifies the infrastructure. For Google API
558 # infrastructure, the error domain is &quot;googleapis.com&quot;.
559 &quot;metadatas&quot;: { # Additional structured details about this error.
560 #
561 # Keys must match a regular expression of `a-z+` but should
562 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
563 # length. When identifying the current value of an exceeded limit, the units
564 # should be contained in the key, not the value. For example, rather than
565 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
566 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
567 # instances that can be created in a single (batch) request.
568 &quot;a_key&quot;: &quot;A String&quot;,
569 },
570 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
571 # proximate cause of the error. Error reasons are unique within a particular
572 # domain of errors. This should be at most 63 characters and match a
573 # regular expression of `A-Z+[A-Z0-9]`, which represents
574 # UPPER_SNAKE_CASE.
575 },
576 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
577 #
578 # For example, if a quota check failed with an error indicating the calling
579 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
580 # directly to the right place in the developer console to flip the bit.
581 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
582 { # Describes a URL link.
583 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
584 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
585 },
586 ],
587 },
588 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
589 # which can be attached to an RPC error.
590 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
591 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
592 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
593 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
594 },
595 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
596 &quot;dimensions&quot;: { # The map holding related quota dimensions.
597 &quot;a_key&quot;: &quot;A String&quot;,
598 },
599 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
600 # type or metric.
601 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
602 # or metric.
603 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
604 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
605 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
606 },
607 },
608 ],
609 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
610 # This property is optional.
611 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
612 },
613 ],
614 },
615 &quot;getVersionOperationMetadata&quot;: {
616 &quot;inlineSbomInfo&quot;: {
617 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
618 # appropriate identifiers.
619 &quot;a_key&quot;: &quot;A String&quot;,
620 },
621 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
622 # identifiers.
623 &quot;a_key&quot;: &quot;A String&quot;,
624 },
625 },
626 },
627 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
628 # message that was returned, such as `NOT FOUND`.
629 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
630 # status code that was returned. For example, a `404` means the
631 # resource was not found.
632 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
633 # defined by the server.
634 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
635 # This value is inRFC3339
636 # text format.
637 &quot;instancesBulkInsertOperationMetadata&quot;: {
638 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
639 # Example key: zones/us-central1-a
640 &quot;a_key&quot;: {
641 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
642 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
643 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
644 # error.
645 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
646 # if the flow is rolling forward or rolling back.
647 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
648 },
649 },
650 },
651 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
652 # Operation resources.
653 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
654 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
655 # group of operations results from a `bulkInsert` API request.
656 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
657 # `update`, or `delete`, and so on.
658 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
659 # There is no requirement that this be linear or support any granularity of
660 # operations. This should not be used to guess when the operation will be
661 # complete. This number should monotonically increase as the operation
662 # progresses.
663 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
664 # applicable when performing regional operations.
665 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
666 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
667 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
668 # this field will contain information on all underlying zonal actions and
669 # their state.
670 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
671 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
672 # Example key: zones/us-central1-a
673 &quot;a_key&quot;: {
674 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
675 # populated.
676 # different programming environments, including REST APIs and RPC APIs. It is
677 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
678 # three pieces of data: error code, error message, and error details.
679 #
680 # You can find out more about this error model and how to work with it in the
681 # [API Design Guide](https://cloud.google.com/apis/design/errors).
682 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
683 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
684 # message types for APIs to use.
685 {
686 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
687 },
688 ],
689 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
690 # user-facing error message should be localized and sent in the
691 # google.rpc.Status.details field, or localized by the client.
692 },
693 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
694 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
695 },
696 },
697 },
698 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
699 # This value is inRFC3339
700 # text format.
701 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
702 # following:
703 # `PENDING`, `RUNNING`, or `DONE`.
704 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
705 # operation.
706 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
707 # of the target resource.
708 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
709 # operations related to creating a snapshot, this points to the disk
710 # that the snapshot was created from.
711 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
712 # `[email protected]` or
713 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
714 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
715 # operation, this field will be populated.
716 {
717 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
718 # Engine returns NO_RESULTS_ON_PAGE if there
719 # are no results in the response.
720 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
721 # value format. For example:
722 #
723 # &quot;data&quot;: [
724 # {
725 # &quot;key&quot;: &quot;scope&quot;,
726 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
727 # }
728 {
729 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
730 # returned. For example, for warnings where there are no results in a list
731 # request for a particular zone, this key might be scope and
732 # the key value might be the zone name. Other examples might be a key
733 # indicating a deprecated resource and a suggested replacement, or a
734 # warning about invalid network settings (for example, if an instance
735 # attempts to perform IP forwarding but is not enabled for IP forwarding).
736 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
737 },
738 ],
739 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
740 },
741 ],
742 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
743 # applicable when performing per-zone operations.
744 }</pre>
745 </div>
746
747 <div class="method">
748 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
749 <pre>Retrieves an aggregated list of target pools.
750
751 To prevent failure, Google recommends that you set the
752 `returnPartialSuccess` parameter to `true`.
753
754 Args:
755 project: string, Project ID for this request. (required)
756 filter: string, A filter expression that filters resources listed in the response. Most
757 Compute resources support two types of filter expressions:
758 expressions that support regular expressions and expressions that follow
759 API improvement proposal AIP-160.
760 These two types of filter expressions cannot be mixed in one request.
761
762 If you want to use AIP-160, your expression must specify the field name, an
763 operator, and the value that you want to use for filtering. The value
764 must be a string, a number, or a boolean. The operator
765 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
766
767 For example, if you are filtering Compute Engine instances, you can
768 exclude instances named `example-instance` by specifying
769 `name != example-instance`.
770
771 The `:*` comparison can be used to test whether a key has been defined.
772 For example, to find all objects with `owner` label use:
773 ```
774 labels.owner:*
775 ```
776
777 You can also filter nested fields. For example, you could specify
778 `scheduling.automaticRestart = false` to include instances only
779 if they are not scheduled for automatic restarts. You can use filtering
780 on nested fields to filter based onresource labels.
781
782 To filter on multiple expressions, provide each separate expression within
783 parentheses. For example:
784 ```
785 (scheduling.automaticRestart = true)
786 (cpuPlatform = &quot;Intel Skylake&quot;)
787 ```
788 By default, each expression is an `AND` expression. However, you
789 can include `AND` and `OR` expressions explicitly.
790 For example:
791 ```
792 (cpuPlatform = &quot;Intel Skylake&quot;) OR
793 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
794 (scheduling.automaticRestart = true)
795 ```
796
797 If you want to use a regular expression, use the `eq` (equal) or `ne`
798 (not equal) operator against a single un-parenthesized expression with or
799 without quotes or against multiple parenthesized expressions. Examples:
800
801 `fieldname eq unquoted literal`
802 `fieldname eq &#x27;single quoted literal&#x27;`
803 `fieldname eq &quot;double quoted literal&quot;`
804 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
805
806 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
807 The literal value must match the entire field.
808
809 For example, to filter for instances that do not end with name &quot;instance&quot;,
810 you would use `name ne .*instance`.
811
812 You cannot combine constraints on multiple fields using regular
813 expressions.
814 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
815 global) should be included in the response. For new resource types added
816 after this field, the flag has no effect as new resource types will always
817 include every visible scope for each scope type in response. For resource
818 types which predate this field, if this flag is omitted or false, only
819 scopes of the scope types where the resource type is expected to be found
820 will be included.
821 maxResults: integer, The maximum number of results per page that should be returned.
822 If the number of available results is larger than `maxResults`,
823 Compute Engine returns a `nextPageToken` that can be used to get
824 the next page of results in subsequent list requests. Acceptable values are
825 `0` to `500`, inclusive. (Default: `500`)
826 orderBy: string, Sorts list results by a certain order. By default, results
827 are returned in alphanumerical order based on the resource name.
828
829 You can also sort results in descending order based on the creation
830 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
831 results based on the `creationTimestamp` field in
832 reverse chronological order (newest result first). Use this to sort
833 resources like operations so that the newest operation is returned first.
834
835 Currently, only sorting by `name` or
836 `creationTimestamp desc` is supported.
837 pageToken: string, Specifies a page token to use. Set `pageToken` to the
838 `nextPageToken` returned by a previous list request to get
839 the next page of results.
840 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
841 of failure. The default value is false.
842
843 For example, when partial success behavior is enabled, aggregatedList for a
844 single zone scope either returns all resources in the zone or no resources,
845 with an error code.
846 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
847 aggregated list request is invoked for subnetworks list-usable api.
848 x__xgafv: string, V1 error format.
849 Allowed values
850 1 - v1 error format
851 2 - v2 error format
852
853 Returns:
854 An object of the form:
855
856 {
857 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
858 &quot;items&quot;: { # A list of TargetPool resources.
859 &quot;a_key&quot;: { # Name of the scope containing this set of target pools.
860 &quot;targetPools&quot;: [ # A list of target pools contained in this scope.
861 { # Represents a Target Pool resource.
862 #
863 # Target pools are used with external passthrough Network Load Balancers.
864 # A target pool references member instances, an associated legacy
865 # HttpHealthCheck resource, and, optionally, a backup target pool.
866 # For more information, readUsing target pools.
867 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when
868 # the containing target pool is serving a forwarding rule as the primary
869 # pool, and its failoverRatio field is properly set to a value
870 # between [0, 1].backupPool and failoverRatio together define
871 # the fallback behavior of the primary target pool: if the ratio of the
872 # healthy instances in the primary pool is at or belowfailoverRatio, traffic arriving at the load-balanced
873 # IP will be directed to the backup pool.
874 #
875 # In case where failoverRatio and backupPool
876 # are not set, or all the instances in the backup pool are unhealthy,
877 # the traffic will be directed back to the primary pool in the &quot;force&quot;
878 # mode, where traffic will be spread to the healthy instances with the
879 # best effort, or to all instances when no instance is healthy.
880 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
881 # text format.
882 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
883 # create the resource.
884 &quot;failoverRatio&quot;: 3.14, # This field is applicable only when the containing target pool is serving a
885 # forwarding rule as the primary pool (i.e., not as a backup pool to some
886 # other target pool). The value of the field must be in [0, 1].
887 #
888 # If set, backupPool must also be set. They together define
889 # the fallback behavior of the primary target pool: if the ratio of the
890 # healthy instances in the primary pool is at or below this number,
891 # traffic arriving at the load-balanced IP will be directed to the
892 # backup pool.
893 #
894 # In case where failoverRatio is not set or all the
895 # instances in the backup pool are unhealthy, the traffic will be
896 # directed back to the primary pool in the &quot;force&quot; mode, where traffic
897 # will be spread to the healthy instances with the
898 # best effort, or to all instances when no instance is healthy.
899 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this
900 # pool is considered healthy if and only if the health checks pass.
901 # Only legacy HttpHealthChecks are supported. Only one health check may be
902 # specified.
903 &quot;A String&quot;,
904 ],
905 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
906 # defined by the server.
907 &quot;instances&quot;: [ # A list of resource URLs to the virtual machine instances serving this pool.
908 # They must live in zones contained in the same region as this pool.
909 &quot;A String&quot;,
910 ],
911 &quot;kind&quot;: &quot;compute#targetPool&quot;, # Output only. [Output Only] Type of the resource. Always compute#targetPool
912 # for target pools.
913 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
914 # The name must be 1-63 characters long, and comply withRFC1035.
915 # Specifically, the name must be 1-63 characters long and match the regular
916 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
917 # character must be a lowercase letter, and all following characters must
918 # be a dash, lowercase letter, or digit, except the last character, which
919 # cannot be a dash.
920 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the target pool resides.
921 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
922 # target pool.
923 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
924 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
925 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
926 # NONE: Connections from the same client IP may go to any
927 # instance in the pool.
928 # CLIENT_IP: Connections from the same client IP will go
929 # to the same instance in
930 # the pool while that instance remains healthy.
931 # CLIENT_IP_PROTO: Connections from the same client IP
932 # with the same IP protocol will go to the same instance in the
933 # pool while that instance remains healthy.
934 },
935 ],
936 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when
937 # the list is empty.
938 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
939 # Engine returns NO_RESULTS_ON_PAGE if there
940 # are no results in the response.
941 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
942 # value format. For example:
943 #
944 # &quot;data&quot;: [
945 # {
946 # &quot;key&quot;: &quot;scope&quot;,
947 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
948 # }
949 {
950 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
951 # returned. For example, for warnings where there are no results in a list
952 # request for a particular zone, this key might be scope and
953 # the key value might be the zone name. Other examples might be a key
954 # indicating a deprecated resource and a suggested replacement, or a
955 # warning about invalid network settings (for example, if an instance
956 # attempts to perform IP forwarding but is not enabled for IP forwarding).
957 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
958 },
959 ],
960 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
961 },
962 },
963 },
964 &quot;kind&quot;: &quot;compute#targetPoolAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#targetPoolAggregatedList for aggregated lists of
965 # target pools.
966 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
967 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
968 # the query parameter pageToken in the next list request.
969 # Subsequent list requests will have their own nextPageToken to
970 # continue paging through the results.
971 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
972 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
973 &quot;A String&quot;,
974 ],
975 &quot;warning&quot;: { # [Output Only] Informational warning message.
976 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
977 # Engine returns NO_RESULTS_ON_PAGE if there
978 # are no results in the response.
979 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
980 # value format. For example:
981 #
982 # &quot;data&quot;: [
983 # {
984 # &quot;key&quot;: &quot;scope&quot;,
985 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
986 # }
987 {
988 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
989 # returned. For example, for warnings where there are no results in a list
990 # request for a particular zone, this key might be scope and
991 # the key value might be the zone name. Other examples might be a key
992 # indicating a deprecated resource and a suggested replacement, or a
993 # warning about invalid network settings (for example, if an instance
994 # attempts to perform IP forwarding but is not enabled for IP forwarding).
995 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
996 },
997 ],
998 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
999 },
1000 }</pre>
1001 </div>
1002
1003 <div class="method">
1004 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1005 <pre>Retrieves the next page of results.
1006
1007 Args:
1008 previous_request: The request for the previous page. (required)
1009 previous_response: The response from the request for the previous page. (required)
1010
1011 Returns:
1012 A request object that you can call &#x27;execute()&#x27; on to request the next
1013 page. Returns None if there are no more items in the collection.
1014 </pre>
1015 </div>
1016
1017 <div class="method">
1018 <code class="details" id="close">close()</code>
1019 <pre>Close httplib2 connections.</pre>
1020 </div>
1021
1022 <div class="method">
1023 <code class="details" id="delete">delete(project, region, targetPool, requestId=None, x__xgafv=None)</code>
1024 <pre>Deletes the specified target pool.
1025
1026 Args:
1027 project: string, Project ID for this request. (required)
1028 region: string, Name of the region scoping this request. (required)
1029 targetPool: string, Name of the TargetPool resource to delete. (required)
1030 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1031 that if you must retry your request, the server will know to ignore the
1032 request if it has already been completed.
1033
1034 For example, consider a situation where you make an initial request and
1035 the request times out. If you make the request again with the same
1036 request ID, the server can check if original operation with the same
1037 request ID was received, and if so, will ignore the second request. This
1038 prevents clients from accidentally creating duplicate commitments.
1039
1040 The request ID must be
1041 a valid UUID with the exception that zero UUID is not supported
1042 (00000000-0000-0000-0000-000000000000).
1043 x__xgafv: string, V1 error format.
1044 Allowed values
1045 1 - v1 error format
1046 2 - v2 error format
1047
1048 Returns:
1049 An object of the form:
1050
1051 { # Represents an Operation resource.
1052 #
1053 # Google Compute Engine has three Operation resources:
1054 #
1055 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1056 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1057 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1058 #
1059 # You can use an operation resource to manage asynchronous API requests.
1060 # For more information, readHandling
1061 # API responses.
1062 #
1063 # Operations can be global, regional or zonal.
1064 #
1065 # - For global operations, use the `globalOperations`
1066 # resource.
1067 # - For regional operations, use the
1068 # `regionOperations` resource.
1069 # - For zonal operations, use
1070 # the `zoneOperations` resource.
1071 #
1072 #
1073 #
1074 # For more information, read
1075 # Global, Regional, and Zonal Resources.
1076 #
1077 # Note that completed Operation resources have a limited
1078 # retention period.
1079 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1080 # Not present otherwise.
1081 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1082 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1083 # set when the operation is created.
1084 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1085 # text format.
1086 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1087 # this field will be populated.
1088 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1089 # operation.
1090 {
1091 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1092 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1093 # details. There is a set of defined message types to use for providing
1094 # details.The syntax depends on the error code. For example,
1095 # QuotaExceededInfo will have details when the error code is
1096 # QUOTA_EXCEEDED.
1097 {
1098 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1099 #
1100 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1101 # is not enabled:
1102 #
1103 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1104 # &quot;domain&quot;: &quot;googleapis.com&quot;
1105 # &quot;metadata&quot;: {
1106 # &quot;resource&quot;: &quot;projects/123&quot;,
1107 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1108 # }
1109 # }
1110 #
1111 # This response indicates that the pubsub.googleapis.com API is not enabled.
1112 #
1113 # Example of an error that is returned when attempting to create a Spanner
1114 # instance in a region that is out of stock:
1115 #
1116 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1117 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1118 # &quot;metadata&quot;: {
1119 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1120 # }
1121 # }
1122 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1123 # is typically the registered service name of the tool or product that
1124 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1125 # generated by some common infrastructure, the error domain must be a
1126 # globally unique value that identifies the infrastructure. For Google API
1127 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1128 &quot;metadatas&quot;: { # Additional structured details about this error.
1129 #
1130 # Keys must match a regular expression of `a-z+` but should
1131 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1132 # length. When identifying the current value of an exceeded limit, the units
1133 # should be contained in the key, not the value. For example, rather than
1134 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1135 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1136 # instances that can be created in a single (batch) request.
1137 &quot;a_key&quot;: &quot;A String&quot;,
1138 },
1139 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1140 # proximate cause of the error. Error reasons are unique within a particular
1141 # domain of errors. This should be at most 63 characters and match a
1142 # regular expression of `A-Z+[A-Z0-9]`, which represents
1143 # UPPER_SNAKE_CASE.
1144 },
1145 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1146 #
1147 # For example, if a quota check failed with an error indicating the calling
1148 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1149 # directly to the right place in the developer console to flip the bit.
1150 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1151 { # Describes a URL link.
1152 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1153 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1154 },
1155 ],
1156 },
1157 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1158 # which can be attached to an RPC error.
1159 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1160 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1161 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1162 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1163 },
1164 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1165 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1166 &quot;a_key&quot;: &quot;A String&quot;,
1167 },
1168 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1169 # type or metric.
1170 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1171 # or metric.
1172 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1173 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1174 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1175 },
1176 },
1177 ],
1178 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1179 # This property is optional.
1180 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1181 },
1182 ],
1183 },
1184 &quot;getVersionOperationMetadata&quot;: {
1185 &quot;inlineSbomInfo&quot;: {
1186 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1187 # appropriate identifiers.
1188 &quot;a_key&quot;: &quot;A String&quot;,
1189 },
1190 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1191 # identifiers.
1192 &quot;a_key&quot;: &quot;A String&quot;,
1193 },
1194 },
1195 },
1196 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1197 # message that was returned, such as `NOT FOUND`.
1198 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1199 # status code that was returned. For example, a `404` means the
1200 # resource was not found.
1201 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1202 # defined by the server.
1203 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1204 # This value is inRFC3339
1205 # text format.
1206 &quot;instancesBulkInsertOperationMetadata&quot;: {
1207 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1208 # Example key: zones/us-central1-a
1209 &quot;a_key&quot;: {
1210 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1211 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1212 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1213 # error.
1214 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1215 # if the flow is rolling forward or rolling back.
1216 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1217 },
1218 },
1219 },
1220 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1221 # Operation resources.
1222 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1223 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1224 # group of operations results from a `bulkInsert` API request.
1225 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1226 # `update`, or `delete`, and so on.
1227 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1228 # There is no requirement that this be linear or support any granularity of
1229 # operations. This should not be used to guess when the operation will be
1230 # complete. This number should monotonically increase as the operation
1231 # progresses.
1232 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1233 # applicable when performing regional operations.
1234 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1235 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1236 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1237 # this field will contain information on all underlying zonal actions and
1238 # their state.
1239 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1240 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1241 # Example key: zones/us-central1-a
1242 &quot;a_key&quot;: {
1243 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1244 # populated.
1245 # different programming environments, including REST APIs and RPC APIs. It is
1246 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1247 # three pieces of data: error code, error message, and error details.
1248 #
1249 # You can find out more about this error model and how to work with it in the
1250 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1251 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1252 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1253 # message types for APIs to use.
1254 {
1255 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1256 },
1257 ],
1258 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1259 # user-facing error message should be localized and sent in the
1260 # google.rpc.Status.details field, or localized by the client.
1261 },
1262 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1263 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1264 },
1265 },
1266 },
1267 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1268 # This value is inRFC3339
1269 # text format.
1270 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1271 # following:
1272 # `PENDING`, `RUNNING`, or `DONE`.
1273 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1274 # operation.
1275 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1276 # of the target resource.
1277 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1278 # operations related to creating a snapshot, this points to the disk
1279 # that the snapshot was created from.
1280 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1281 # `[email protected]` or
1282 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1283 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1284 # operation, this field will be populated.
1285 {
1286 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1287 # Engine returns NO_RESULTS_ON_PAGE if there
1288 # are no results in the response.
1289 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1290 # value format. For example:
1291 #
1292 # &quot;data&quot;: [
1293 # {
1294 # &quot;key&quot;: &quot;scope&quot;,
1295 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1296 # }
1297 {
1298 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1299 # returned. For example, for warnings where there are no results in a list
1300 # request for a particular zone, this key might be scope and
1301 # the key value might be the zone name. Other examples might be a key
1302 # indicating a deprecated resource and a suggested replacement, or a
1303 # warning about invalid network settings (for example, if an instance
1304 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1305 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1306 },
1307 ],
1308 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1309 },
1310 ],
1311 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1312 # applicable when performing per-zone operations.
1313 }</pre>
1314 </div>
1315
1316 <div class="method">
1317 <code class="details" id="get">get(project, region, targetPool, x__xgafv=None)</code>
1318 <pre>Returns the specified target pool.
1319
1320 Args:
1321 project: string, Project ID for this request. (required)
1322 region: string, Name of the region scoping this request. (required)
1323 targetPool: string, Name of the TargetPool resource to return. (required)
1324 x__xgafv: string, V1 error format.
1325 Allowed values
1326 1 - v1 error format
1327 2 - v2 error format
1328
1329 Returns:
1330 An object of the form:
1331
1332 { # Represents a Target Pool resource.
1333 #
1334 # Target pools are used with external passthrough Network Load Balancers.
1335 # A target pool references member instances, an associated legacy
1336 # HttpHealthCheck resource, and, optionally, a backup target pool.
1337 # For more information, readUsing target pools.
1338 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when
1339 # the containing target pool is serving a forwarding rule as the primary
1340 # pool, and its failoverRatio field is properly set to a value
1341 # between [0, 1].backupPool and failoverRatio together define
1342 # the fallback behavior of the primary target pool: if the ratio of the
1343 # healthy instances in the primary pool is at or belowfailoverRatio, traffic arriving at the load-balanced
1344 # IP will be directed to the backup pool.
1345 #
1346 # In case where failoverRatio and backupPool
1347 # are not set, or all the instances in the backup pool are unhealthy,
1348 # the traffic will be directed back to the primary pool in the &quot;force&quot;
1349 # mode, where traffic will be spread to the healthy instances with the
1350 # best effort, or to all instances when no instance is healthy.
1351 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1352 # text format.
1353 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1354 # create the resource.
1355 &quot;failoverRatio&quot;: 3.14, # This field is applicable only when the containing target pool is serving a
1356 # forwarding rule as the primary pool (i.e., not as a backup pool to some
1357 # other target pool). The value of the field must be in [0, 1].
1358 #
1359 # If set, backupPool must also be set. They together define
1360 # the fallback behavior of the primary target pool: if the ratio of the
1361 # healthy instances in the primary pool is at or below this number,
1362 # traffic arriving at the load-balanced IP will be directed to the
1363 # backup pool.
1364 #
1365 # In case where failoverRatio is not set or all the
1366 # instances in the backup pool are unhealthy, the traffic will be
1367 # directed back to the primary pool in the &quot;force&quot; mode, where traffic
1368 # will be spread to the healthy instances with the
1369 # best effort, or to all instances when no instance is healthy.
1370 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this
1371 # pool is considered healthy if and only if the health checks pass.
1372 # Only legacy HttpHealthChecks are supported. Only one health check may be
1373 # specified.
1374 &quot;A String&quot;,
1375 ],
1376 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1377 # defined by the server.
1378 &quot;instances&quot;: [ # A list of resource URLs to the virtual machine instances serving this pool.
1379 # They must live in zones contained in the same region as this pool.
1380 &quot;A String&quot;,
1381 ],
1382 &quot;kind&quot;: &quot;compute#targetPool&quot;, # Output only. [Output Only] Type of the resource. Always compute#targetPool
1383 # for target pools.
1384 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1385 # The name must be 1-63 characters long, and comply withRFC1035.
1386 # Specifically, the name must be 1-63 characters long and match the regular
1387 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1388 # character must be a lowercase letter, and all following characters must
1389 # be a dash, lowercase letter, or digit, except the last character, which
1390 # cannot be a dash.
1391 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the target pool resides.
1392 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1393 # target pool.
1394 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1395 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1396 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
1397 # NONE: Connections from the same client IP may go to any
1398 # instance in the pool.
1399 # CLIENT_IP: Connections from the same client IP will go
1400 # to the same instance in
1401 # the pool while that instance remains healthy.
1402 # CLIENT_IP_PROTO: Connections from the same client IP
1403 # with the same IP protocol will go to the same instance in the
1404 # pool while that instance remains healthy.
1405 }</pre>
1406 </div>
1407
1408 <div class="method">
1409 <code class="details" id="getHealth">getHealth(project, region, targetPool, body=None, x__xgafv=None)</code>
1410 <pre>Gets the most recent health check results for each IP for the
1411 instance that is referenced by the given target pool.
1412
1413 Args:
1414 project: string, Project ID for this request. (required)
1415 region: string, Name of the region scoping this request. (required)
1416 targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
1417 body: object, The request body.
1418 The object takes the form of:
1419
1420 {
1421 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
1422 # @required compute.instancegroups.addInstances/removeInstances
1423 }
1424
1425 x__xgafv: string, V1 error format.
1426 Allowed values
1427 1 - v1 error format
1428 2 - v2 error format
1429
1430 Returns:
1431 An object of the form:
1432
1433 {
1434 &quot;healthStatus&quot;: [
1435 {
1436 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
1437 &quot;a_key&quot;: &quot;A String&quot;,
1438 },
1439 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
1440 # instance.
1441 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
1442 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
1443 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
1444 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
1445 # rule&#x27;s IP address assigned to this instance. For other types of load
1446 # balancing, the field indicates VM internal ip.
1447 &quot;ipv6Address&quot;: &quot;A String&quot;,
1448 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
1449 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
1450 # health-checked.
1451 &quot;weight&quot;: &quot;A String&quot;,
1452 &quot;weightError&quot;: &quot;A String&quot;,
1453 },
1454 ],
1455 &quot;kind&quot;: &quot;compute#targetPoolInstanceHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#targetPoolInstanceHealth when checking the health of
1456 # an instance.
1457 }</pre>
1458 </div>
1459
1460 <div class="method">
1461 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
1462 <pre>Creates a target pool in the specified project and region using
1463 the data included in the request.
1464
1465 Args:
1466 project: string, Project ID for this request. (required)
1467 region: string, Name of the region scoping this request. (required)
1468 body: object, The request body.
1469 The object takes the form of:
1470
1471 { # Represents a Target Pool resource.
1472 #
1473 # Target pools are used with external passthrough Network Load Balancers.
1474 # A target pool references member instances, an associated legacy
1475 # HttpHealthCheck resource, and, optionally, a backup target pool.
1476 # For more information, readUsing target pools.
1477 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when
1478 # the containing target pool is serving a forwarding rule as the primary
1479 # pool, and its failoverRatio field is properly set to a value
1480 # between [0, 1].backupPool and failoverRatio together define
1481 # the fallback behavior of the primary target pool: if the ratio of the
1482 # healthy instances in the primary pool is at or belowfailoverRatio, traffic arriving at the load-balanced
1483 # IP will be directed to the backup pool.
1484 #
1485 # In case where failoverRatio and backupPool
1486 # are not set, or all the instances in the backup pool are unhealthy,
1487 # the traffic will be directed back to the primary pool in the &quot;force&quot;
1488 # mode, where traffic will be spread to the healthy instances with the
1489 # best effort, or to all instances when no instance is healthy.
1490 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1491 # text format.
1492 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1493 # create the resource.
1494 &quot;failoverRatio&quot;: 3.14, # This field is applicable only when the containing target pool is serving a
1495 # forwarding rule as the primary pool (i.e., not as a backup pool to some
1496 # other target pool). The value of the field must be in [0, 1].
1497 #
1498 # If set, backupPool must also be set. They together define
1499 # the fallback behavior of the primary target pool: if the ratio of the
1500 # healthy instances in the primary pool is at or below this number,
1501 # traffic arriving at the load-balanced IP will be directed to the
1502 # backup pool.
1503 #
1504 # In case where failoverRatio is not set or all the
1505 # instances in the backup pool are unhealthy, the traffic will be
1506 # directed back to the primary pool in the &quot;force&quot; mode, where traffic
1507 # will be spread to the healthy instances with the
1508 # best effort, or to all instances when no instance is healthy.
1509 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this
1510 # pool is considered healthy if and only if the health checks pass.
1511 # Only legacy HttpHealthChecks are supported. Only one health check may be
1512 # specified.
1513 &quot;A String&quot;,
1514 ],
1515 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1516 # defined by the server.
1517 &quot;instances&quot;: [ # A list of resource URLs to the virtual machine instances serving this pool.
1518 # They must live in zones contained in the same region as this pool.
1519 &quot;A String&quot;,
1520 ],
1521 &quot;kind&quot;: &quot;compute#targetPool&quot;, # Output only. [Output Only] Type of the resource. Always compute#targetPool
1522 # for target pools.
1523 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1524 # The name must be 1-63 characters long, and comply withRFC1035.
1525 # Specifically, the name must be 1-63 characters long and match the regular
1526 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1527 # character must be a lowercase letter, and all following characters must
1528 # be a dash, lowercase letter, or digit, except the last character, which
1529 # cannot be a dash.
1530 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the target pool resides.
1531 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1532 # target pool.
1533 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1534 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1535 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
1536 # NONE: Connections from the same client IP may go to any
1537 # instance in the pool.
1538 # CLIENT_IP: Connections from the same client IP will go
1539 # to the same instance in
1540 # the pool while that instance remains healthy.
1541 # CLIENT_IP_PROTO: Connections from the same client IP
1542 # with the same IP protocol will go to the same instance in the
1543 # pool while that instance remains healthy.
1544 }
1545
1546 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1547 that if you must retry your request, the server will know to ignore the
1548 request if it has already been completed.
1549
1550 For example, consider a situation where you make an initial request and
1551 the request times out. If you make the request again with the same
1552 request ID, the server can check if original operation with the same
1553 request ID was received, and if so, will ignore the second request. This
1554 prevents clients from accidentally creating duplicate commitments.
1555
1556 The request ID must be
1557 a valid UUID with the exception that zero UUID is not supported
1558 (00000000-0000-0000-0000-000000000000).
1559 x__xgafv: string, V1 error format.
1560 Allowed values
1561 1 - v1 error format
1562 2 - v2 error format
1563
1564 Returns:
1565 An object of the form:
1566
1567 { # Represents an Operation resource.
1568 #
1569 # Google Compute Engine has three Operation resources:
1570 #
1571 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1572 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1573 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1574 #
1575 # You can use an operation resource to manage asynchronous API requests.
1576 # For more information, readHandling
1577 # API responses.
1578 #
1579 # Operations can be global, regional or zonal.
1580 #
1581 # - For global operations, use the `globalOperations`
1582 # resource.
1583 # - For regional operations, use the
1584 # `regionOperations` resource.
1585 # - For zonal operations, use
1586 # the `zoneOperations` resource.
1587 #
1588 #
1589 #
1590 # For more information, read
1591 # Global, Regional, and Zonal Resources.
1592 #
1593 # Note that completed Operation resources have a limited
1594 # retention period.
1595 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1596 # Not present otherwise.
1597 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1598 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1599 # set when the operation is created.
1600 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1601 # text format.
1602 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1603 # this field will be populated.
1604 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1605 # operation.
1606 {
1607 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1608 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1609 # details. There is a set of defined message types to use for providing
1610 # details.The syntax depends on the error code. For example,
1611 # QuotaExceededInfo will have details when the error code is
1612 # QUOTA_EXCEEDED.
1613 {
1614 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1615 #
1616 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1617 # is not enabled:
1618 #
1619 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1620 # &quot;domain&quot;: &quot;googleapis.com&quot;
1621 # &quot;metadata&quot;: {
1622 # &quot;resource&quot;: &quot;projects/123&quot;,
1623 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1624 # }
1625 # }
1626 #
1627 # This response indicates that the pubsub.googleapis.com API is not enabled.
1628 #
1629 # Example of an error that is returned when attempting to create a Spanner
1630 # instance in a region that is out of stock:
1631 #
1632 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1633 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1634 # &quot;metadata&quot;: {
1635 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1636 # }
1637 # }
1638 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1639 # is typically the registered service name of the tool or product that
1640 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1641 # generated by some common infrastructure, the error domain must be a
1642 # globally unique value that identifies the infrastructure. For Google API
1643 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1644 &quot;metadatas&quot;: { # Additional structured details about this error.
1645 #
1646 # Keys must match a regular expression of `a-z+` but should
1647 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1648 # length. When identifying the current value of an exceeded limit, the units
1649 # should be contained in the key, not the value. For example, rather than
1650 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1651 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1652 # instances that can be created in a single (batch) request.
1653 &quot;a_key&quot;: &quot;A String&quot;,
1654 },
1655 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1656 # proximate cause of the error. Error reasons are unique within a particular
1657 # domain of errors. This should be at most 63 characters and match a
1658 # regular expression of `A-Z+[A-Z0-9]`, which represents
1659 # UPPER_SNAKE_CASE.
1660 },
1661 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1662 #
1663 # For example, if a quota check failed with an error indicating the calling
1664 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1665 # directly to the right place in the developer console to flip the bit.
1666 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1667 { # Describes a URL link.
1668 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1669 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1670 },
1671 ],
1672 },
1673 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1674 # which can be attached to an RPC error.
1675 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1676 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1677 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1678 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1679 },
1680 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1681 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1682 &quot;a_key&quot;: &quot;A String&quot;,
1683 },
1684 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1685 # type or metric.
1686 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1687 # or metric.
1688 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1689 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1690 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1691 },
1692 },
1693 ],
1694 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1695 # This property is optional.
1696 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1697 },
1698 ],
1699 },
1700 &quot;getVersionOperationMetadata&quot;: {
1701 &quot;inlineSbomInfo&quot;: {
1702 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1703 # appropriate identifiers.
1704 &quot;a_key&quot;: &quot;A String&quot;,
1705 },
1706 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1707 # identifiers.
1708 &quot;a_key&quot;: &quot;A String&quot;,
1709 },
1710 },
1711 },
1712 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1713 # message that was returned, such as `NOT FOUND`.
1714 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1715 # status code that was returned. For example, a `404` means the
1716 # resource was not found.
1717 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1718 # defined by the server.
1719 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1720 # This value is inRFC3339
1721 # text format.
1722 &quot;instancesBulkInsertOperationMetadata&quot;: {
1723 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1724 # Example key: zones/us-central1-a
1725 &quot;a_key&quot;: {
1726 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1727 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1728 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1729 # error.
1730 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1731 # if the flow is rolling forward or rolling back.
1732 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1733 },
1734 },
1735 },
1736 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1737 # Operation resources.
1738 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1739 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1740 # group of operations results from a `bulkInsert` API request.
1741 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1742 # `update`, or `delete`, and so on.
1743 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1744 # There is no requirement that this be linear or support any granularity of
1745 # operations. This should not be used to guess when the operation will be
1746 # complete. This number should monotonically increase as the operation
1747 # progresses.
1748 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1749 # applicable when performing regional operations.
1750 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1751 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1752 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1753 # this field will contain information on all underlying zonal actions and
1754 # their state.
1755 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1756 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1757 # Example key: zones/us-central1-a
1758 &quot;a_key&quot;: {
1759 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1760 # populated.
1761 # different programming environments, including REST APIs and RPC APIs. It is
1762 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1763 # three pieces of data: error code, error message, and error details.
1764 #
1765 # You can find out more about this error model and how to work with it in the
1766 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1767 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1768 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1769 # message types for APIs to use.
1770 {
1771 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1772 },
1773 ],
1774 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1775 # user-facing error message should be localized and sent in the
1776 # google.rpc.Status.details field, or localized by the client.
1777 },
1778 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1779 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1780 },
1781 },
1782 },
1783 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1784 # This value is inRFC3339
1785 # text format.
1786 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1787 # following:
1788 # `PENDING`, `RUNNING`, or `DONE`.
1789 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1790 # operation.
1791 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1792 # of the target resource.
1793 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1794 # operations related to creating a snapshot, this points to the disk
1795 # that the snapshot was created from.
1796 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1797 # `[email protected]` or
1798 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1799 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1800 # operation, this field will be populated.
1801 {
1802 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1803 # Engine returns NO_RESULTS_ON_PAGE if there
1804 # are no results in the response.
1805 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1806 # value format. For example:
1807 #
1808 # &quot;data&quot;: [
1809 # {
1810 # &quot;key&quot;: &quot;scope&quot;,
1811 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1812 # }
1813 {
1814 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1815 # returned. For example, for warnings where there are no results in a list
1816 # request for a particular zone, this key might be scope and
1817 # the key value might be the zone name. Other examples might be a key
1818 # indicating a deprecated resource and a suggested replacement, or a
1819 # warning about invalid network settings (for example, if an instance
1820 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1821 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1822 },
1823 ],
1824 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1825 },
1826 ],
1827 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1828 # applicable when performing per-zone operations.
1829 }</pre>
1830 </div>
1831
1832 <div class="method">
1833 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1834 <pre>Retrieves a list of target pools available to the specified
1835 project and region.
1836
1837 Args:
1838 project: string, Project ID for this request. (required)
1839 region: string, Name of the region scoping this request. (required)
1840 filter: string, A filter expression that filters resources listed in the response. Most
1841 Compute resources support two types of filter expressions:
1842 expressions that support regular expressions and expressions that follow
1843 API improvement proposal AIP-160.
1844 These two types of filter expressions cannot be mixed in one request.
1845
1846 If you want to use AIP-160, your expression must specify the field name, an
1847 operator, and the value that you want to use for filtering. The value
1848 must be a string, a number, or a boolean. The operator
1849 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1850
1851 For example, if you are filtering Compute Engine instances, you can
1852 exclude instances named `example-instance` by specifying
1853 `name != example-instance`.
1854
1855 The `:*` comparison can be used to test whether a key has been defined.
1856 For example, to find all objects with `owner` label use:
1857 ```
1858 labels.owner:*
1859 ```
1860
1861 You can also filter nested fields. For example, you could specify
1862 `scheduling.automaticRestart = false` to include instances only
1863 if they are not scheduled for automatic restarts. You can use filtering
1864 on nested fields to filter based onresource labels.
1865
1866 To filter on multiple expressions, provide each separate expression within
1867 parentheses. For example:
1868 ```
1869 (scheduling.automaticRestart = true)
1870 (cpuPlatform = &quot;Intel Skylake&quot;)
1871 ```
1872 By default, each expression is an `AND` expression. However, you
1873 can include `AND` and `OR` expressions explicitly.
1874 For example:
1875 ```
1876 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1877 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1878 (scheduling.automaticRestart = true)
1879 ```
1880
1881 If you want to use a regular expression, use the `eq` (equal) or `ne`
1882 (not equal) operator against a single un-parenthesized expression with or
1883 without quotes or against multiple parenthesized expressions. Examples:
1884
1885 `fieldname eq unquoted literal`
1886 `fieldname eq &#x27;single quoted literal&#x27;`
1887 `fieldname eq &quot;double quoted literal&quot;`
1888 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1889
1890 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1891 The literal value must match the entire field.
1892
1893 For example, to filter for instances that do not end with name &quot;instance&quot;,
1894 you would use `name ne .*instance`.
1895
1896 You cannot combine constraints on multiple fields using regular
1897 expressions.
1898 maxResults: integer, The maximum number of results per page that should be returned.
1899 If the number of available results is larger than `maxResults`,
1900 Compute Engine returns a `nextPageToken` that can be used to get
1901 the next page of results in subsequent list requests. Acceptable values are
1902 `0` to `500`, inclusive. (Default: `500`)
1903 orderBy: string, Sorts list results by a certain order. By default, results
1904 are returned in alphanumerical order based on the resource name.
1905
1906 You can also sort results in descending order based on the creation
1907 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1908 results based on the `creationTimestamp` field in
1909 reverse chronological order (newest result first). Use this to sort
1910 resources like operations so that the newest operation is returned first.
1911
1912 Currently, only sorting by `name` or
1913 `creationTimestamp desc` is supported.
1914 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1915 `nextPageToken` returned by a previous list request to get
1916 the next page of results.
1917 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1918 of failure. The default value is false.
1919
1920 For example, when partial success behavior is enabled, aggregatedList for a
1921 single zone scope either returns all resources in the zone or no resources,
1922 with an error code.
1923 x__xgafv: string, V1 error format.
1924 Allowed values
1925 1 - v1 error format
1926 2 - v2 error format
1927
1928 Returns:
1929 An object of the form:
1930
1931 { # Contains a list of TargetPool resources.
1932 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1933 &quot;items&quot;: [ # A list of TargetPool resources.
1934 { # Represents a Target Pool resource.
1935 #
1936 # Target pools are used with external passthrough Network Load Balancers.
1937 # A target pool references member instances, an associated legacy
1938 # HttpHealthCheck resource, and, optionally, a backup target pool.
1939 # For more information, readUsing target pools.
1940 &quot;backupPool&quot;: &quot;A String&quot;, # The server-defined URL for the resource. This field is applicable only when
1941 # the containing target pool is serving a forwarding rule as the primary
1942 # pool, and its failoverRatio field is properly set to a value
1943 # between [0, 1].backupPool and failoverRatio together define
1944 # the fallback behavior of the primary target pool: if the ratio of the
1945 # healthy instances in the primary pool is at or belowfailoverRatio, traffic arriving at the load-balanced
1946 # IP will be directed to the backup pool.
1947 #
1948 # In case where failoverRatio and backupPool
1949 # are not set, or all the instances in the backup pool are unhealthy,
1950 # the traffic will be directed back to the primary pool in the &quot;force&quot;
1951 # mode, where traffic will be spread to the healthy instances with the
1952 # best effort, or to all instances when no instance is healthy.
1953 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1954 # text format.
1955 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1956 # create the resource.
1957 &quot;failoverRatio&quot;: 3.14, # This field is applicable only when the containing target pool is serving a
1958 # forwarding rule as the primary pool (i.e., not as a backup pool to some
1959 # other target pool). The value of the field must be in [0, 1].
1960 #
1961 # If set, backupPool must also be set. They together define
1962 # the fallback behavior of the primary target pool: if the ratio of the
1963 # healthy instances in the primary pool is at or below this number,
1964 # traffic arriving at the load-balanced IP will be directed to the
1965 # backup pool.
1966 #
1967 # In case where failoverRatio is not set or all the
1968 # instances in the backup pool are unhealthy, the traffic will be
1969 # directed back to the primary pool in the &quot;force&quot; mode, where traffic
1970 # will be spread to the healthy instances with the
1971 # best effort, or to all instances when no instance is healthy.
1972 &quot;healthChecks&quot;: [ # The URL of the HttpHealthCheck resource. A member instance in this
1973 # pool is considered healthy if and only if the health checks pass.
1974 # Only legacy HttpHealthChecks are supported. Only one health check may be
1975 # specified.
1976 &quot;A String&quot;,
1977 ],
1978 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1979 # defined by the server.
1980 &quot;instances&quot;: [ # A list of resource URLs to the virtual machine instances serving this pool.
1981 # They must live in zones contained in the same region as this pool.
1982 &quot;A String&quot;,
1983 ],
1984 &quot;kind&quot;: &quot;compute#targetPool&quot;, # Output only. [Output Only] Type of the resource. Always compute#targetPool
1985 # for target pools.
1986 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1987 # The name must be 1-63 characters long, and comply withRFC1035.
1988 # Specifically, the name must be 1-63 characters long and match the regular
1989 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1990 # character must be a lowercase letter, and all following characters must
1991 # be a dash, lowercase letter, or digit, except the last character, which
1992 # cannot be a dash.
1993 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the target pool resides.
1994 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1995 # target pool.
1996 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1997 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1998 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Session affinity option, must be one of the following values:
1999 # NONE: Connections from the same client IP may go to any
2000 # instance in the pool.
2001 # CLIENT_IP: Connections from the same client IP will go
2002 # to the same instance in
2003 # the pool while that instance remains healthy.
2004 # CLIENT_IP_PROTO: Connections from the same client IP
2005 # with the same IP protocol will go to the same instance in the
2006 # pool while that instance remains healthy.
2007 },
2008 ],
2009 &quot;kind&quot;: &quot;compute#targetPoolList&quot;, # Output only. [Output Only] Type of resource. Always compute#targetPoolList
2010 # for lists of target pools.
2011 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2012 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2013 # the query parameter pageToken in the next list request.
2014 # Subsequent list requests will have their own nextPageToken to
2015 # continue paging through the results.
2016 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2017 &quot;warning&quot;: { # [Output Only] Informational warning message.
2018 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2019 # Engine returns NO_RESULTS_ON_PAGE if there
2020 # are no results in the response.
2021 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2022 # value format. For example:
2023 #
2024 # &quot;data&quot;: [
2025 # {
2026 # &quot;key&quot;: &quot;scope&quot;,
2027 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2028 # }
2029 {
2030 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2031 # returned. For example, for warnings where there are no results in a list
2032 # request for a particular zone, this key might be scope and
2033 # the key value might be the zone name. Other examples might be a key
2034 # indicating a deprecated resource and a suggested replacement, or a
2035 # warning about invalid network settings (for example, if an instance
2036 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2037 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2038 },
2039 ],
2040 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2041 },
2042 }</pre>
2043 </div>
2044
2045 <div class="method">
2046 <code class="details" id="list_next">list_next()</code>
2047 <pre>Retrieves the next page of results.
2048
2049 Args:
2050 previous_request: The request for the previous page. (required)
2051 previous_response: The response from the request for the previous page. (required)
2052
2053 Returns:
2054 A request object that you can call &#x27;execute()&#x27; on to request the next
2055 page. Returns None if there are no more items in the collection.
2056 </pre>
2057 </div>
2058
2059 <div class="method">
2060 <code class="details" id="removeHealthCheck">removeHealthCheck(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
2061 <pre>Removes health check URL from a target pool.
2062
2063 Args:
2064 project: string, Project ID for this request. (required)
2065 region: string, Name of the region for this request. (required)
2066 targetPool: string, Name of the target pool to remove health checks from. (required)
2067 body: object, The request body.
2068 The object takes the form of:
2069
2070 {
2071 &quot;healthChecks&quot;: [ # Health check URL to be removed. This can be a full or valid partial URL.
2072 # For example, the following are valid URLs:
2073 #
2074 # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
2075 # - projects/project/global/httpHealthChecks/health-check
2076 # - global/httpHealthChecks/health-check
2077 { # A full or valid partial URL to a health check. For example, the following are
2078 # valid URLs:
2079 #
2080 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
2081 # - projects/project-id/global/httpHealthChecks/health-check
2082 # - global/httpHealthChecks/health-check
2083 &quot;healthCheck&quot;: &quot;A String&quot;,
2084 },
2085 ],
2086 }
2087
2088 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2089 that if you must retry your request, the server will know to ignore the
2090 request if it has already been completed.
2091
2092 For example, consider a situation where you make an initial request and
2093 the request times out. If you make the request again with the same
2094 request ID, the server can check if original operation with the same
2095 request ID was received, and if so, will ignore the second request. This
2096 prevents clients from accidentally creating duplicate commitments.
2097
2098 The request ID must be
2099 a valid UUID with the exception that zero UUID is not supported
2100 (00000000-0000-0000-0000-000000000000).
2101 x__xgafv: string, V1 error format.
2102 Allowed values
2103 1 - v1 error format
2104 2 - v2 error format
2105
2106 Returns:
2107 An object of the form:
2108
2109 { # Represents an Operation resource.
2110 #
2111 # Google Compute Engine has three Operation resources:
2112 #
2113 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2114 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2115 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2116 #
2117 # You can use an operation resource to manage asynchronous API requests.
2118 # For more information, readHandling
2119 # API responses.
2120 #
2121 # Operations can be global, regional or zonal.
2122 #
2123 # - For global operations, use the `globalOperations`
2124 # resource.
2125 # - For regional operations, use the
2126 # `regionOperations` resource.
2127 # - For zonal operations, use
2128 # the `zoneOperations` resource.
2129 #
2130 #
2131 #
2132 # For more information, read
2133 # Global, Regional, and Zonal Resources.
2134 #
2135 # Note that completed Operation resources have a limited
2136 # retention period.
2137 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2138 # Not present otherwise.
2139 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2140 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2141 # set when the operation is created.
2142 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2143 # text format.
2144 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2145 # this field will be populated.
2146 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2147 # operation.
2148 {
2149 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2150 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2151 # details. There is a set of defined message types to use for providing
2152 # details.The syntax depends on the error code. For example,
2153 # QuotaExceededInfo will have details when the error code is
2154 # QUOTA_EXCEEDED.
2155 {
2156 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2157 #
2158 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2159 # is not enabled:
2160 #
2161 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2162 # &quot;domain&quot;: &quot;googleapis.com&quot;
2163 # &quot;metadata&quot;: {
2164 # &quot;resource&quot;: &quot;projects/123&quot;,
2165 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2166 # }
2167 # }
2168 #
2169 # This response indicates that the pubsub.googleapis.com API is not enabled.
2170 #
2171 # Example of an error that is returned when attempting to create a Spanner
2172 # instance in a region that is out of stock:
2173 #
2174 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2175 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2176 # &quot;metadata&quot;: {
2177 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2178 # }
2179 # }
2180 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2181 # is typically the registered service name of the tool or product that
2182 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2183 # generated by some common infrastructure, the error domain must be a
2184 # globally unique value that identifies the infrastructure. For Google API
2185 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2186 &quot;metadatas&quot;: { # Additional structured details about this error.
2187 #
2188 # Keys must match a regular expression of `a-z+` but should
2189 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2190 # length. When identifying the current value of an exceeded limit, the units
2191 # should be contained in the key, not the value. For example, rather than
2192 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2193 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2194 # instances that can be created in a single (batch) request.
2195 &quot;a_key&quot;: &quot;A String&quot;,
2196 },
2197 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2198 # proximate cause of the error. Error reasons are unique within a particular
2199 # domain of errors. This should be at most 63 characters and match a
2200 # regular expression of `A-Z+[A-Z0-9]`, which represents
2201 # UPPER_SNAKE_CASE.
2202 },
2203 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2204 #
2205 # For example, if a quota check failed with an error indicating the calling
2206 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2207 # directly to the right place in the developer console to flip the bit.
2208 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2209 { # Describes a URL link.
2210 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2211 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2212 },
2213 ],
2214 },
2215 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2216 # which can be attached to an RPC error.
2217 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2218 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2219 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2220 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2221 },
2222 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2223 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2224 &quot;a_key&quot;: &quot;A String&quot;,
2225 },
2226 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2227 # type or metric.
2228 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2229 # or metric.
2230 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2231 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2232 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2233 },
2234 },
2235 ],
2236 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2237 # This property is optional.
2238 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2239 },
2240 ],
2241 },
2242 &quot;getVersionOperationMetadata&quot;: {
2243 &quot;inlineSbomInfo&quot;: {
2244 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2245 # appropriate identifiers.
2246 &quot;a_key&quot;: &quot;A String&quot;,
2247 },
2248 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2249 # identifiers.
2250 &quot;a_key&quot;: &quot;A String&quot;,
2251 },
2252 },
2253 },
2254 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2255 # message that was returned, such as `NOT FOUND`.
2256 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2257 # status code that was returned. For example, a `404` means the
2258 # resource was not found.
2259 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2260 # defined by the server.
2261 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2262 # This value is inRFC3339
2263 # text format.
2264 &quot;instancesBulkInsertOperationMetadata&quot;: {
2265 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2266 # Example key: zones/us-central1-a
2267 &quot;a_key&quot;: {
2268 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2269 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2270 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2271 # error.
2272 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2273 # if the flow is rolling forward or rolling back.
2274 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2275 },
2276 },
2277 },
2278 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2279 # Operation resources.
2280 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2281 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2282 # group of operations results from a `bulkInsert` API request.
2283 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2284 # `update`, or `delete`, and so on.
2285 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2286 # There is no requirement that this be linear or support any granularity of
2287 # operations. This should not be used to guess when the operation will be
2288 # complete. This number should monotonically increase as the operation
2289 # progresses.
2290 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2291 # applicable when performing regional operations.
2292 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2293 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2294 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2295 # this field will contain information on all underlying zonal actions and
2296 # their state.
2297 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2298 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2299 # Example key: zones/us-central1-a
2300 &quot;a_key&quot;: {
2301 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2302 # populated.
2303 # different programming environments, including REST APIs and RPC APIs. It is
2304 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2305 # three pieces of data: error code, error message, and error details.
2306 #
2307 # You can find out more about this error model and how to work with it in the
2308 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2309 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2310 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2311 # message types for APIs to use.
2312 {
2313 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2314 },
2315 ],
2316 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2317 # user-facing error message should be localized and sent in the
2318 # google.rpc.Status.details field, or localized by the client.
2319 },
2320 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2321 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2322 },
2323 },
2324 },
2325 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2326 # This value is inRFC3339
2327 # text format.
2328 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2329 # following:
2330 # `PENDING`, `RUNNING`, or `DONE`.
2331 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2332 # operation.
2333 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2334 # of the target resource.
2335 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2336 # operations related to creating a snapshot, this points to the disk
2337 # that the snapshot was created from.
2338 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2339 # `[email protected]` or
2340 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2341 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2342 # operation, this field will be populated.
2343 {
2344 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2345 # Engine returns NO_RESULTS_ON_PAGE if there
2346 # are no results in the response.
2347 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2348 # value format. For example:
2349 #
2350 # &quot;data&quot;: [
2351 # {
2352 # &quot;key&quot;: &quot;scope&quot;,
2353 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2354 # }
2355 {
2356 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2357 # returned. For example, for warnings where there are no results in a list
2358 # request for a particular zone, this key might be scope and
2359 # the key value might be the zone name. Other examples might be a key
2360 # indicating a deprecated resource and a suggested replacement, or a
2361 # warning about invalid network settings (for example, if an instance
2362 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2363 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2364 },
2365 ],
2366 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2367 },
2368 ],
2369 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2370 # applicable when performing per-zone operations.
2371 }</pre>
2372 </div>
2373
2374 <div class="method">
2375 <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
2376 <pre>Removes instance URL from a target pool.
2377
2378 Args:
2379 project: string, Project ID for this request. (required)
2380 region: string, Name of the region scoping this request. (required)
2381 targetPool: string, Name of the TargetPool resource to remove instances from. (required)
2382 body: object, The request body.
2383 The object takes the form of:
2384
2385 {
2386 &quot;instances&quot;: [ # URLs of the instances to be removed from target pool.
2387 {
2388 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
2389 # @required compute.instancegroups.addInstances/removeInstances
2390 },
2391 ],
2392 }
2393
2394 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2395 that if you must retry your request, the server will know to ignore the
2396 request if it has already been completed.
2397
2398 For example, consider a situation where you make an initial request and
2399 the request times out. If you make the request again with the same
2400 request ID, the server can check if original operation with the same
2401 request ID was received, and if so, will ignore the second request. This
2402 prevents clients from accidentally creating duplicate commitments.
2403
2404 The request ID must be
2405 a valid UUID with the exception that zero UUID is not supported
2406 (00000000-0000-0000-0000-000000000000).
2407 x__xgafv: string, V1 error format.
2408 Allowed values
2409 1 - v1 error format
2410 2 - v2 error format
2411
2412 Returns:
2413 An object of the form:
2414
2415 { # Represents an Operation resource.
2416 #
2417 # Google Compute Engine has three Operation resources:
2418 #
2419 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2420 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2421 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2422 #
2423 # You can use an operation resource to manage asynchronous API requests.
2424 # For more information, readHandling
2425 # API responses.
2426 #
2427 # Operations can be global, regional or zonal.
2428 #
2429 # - For global operations, use the `globalOperations`
2430 # resource.
2431 # - For regional operations, use the
2432 # `regionOperations` resource.
2433 # - For zonal operations, use
2434 # the `zoneOperations` resource.
2435 #
2436 #
2437 #
2438 # For more information, read
2439 # Global, Regional, and Zonal Resources.
2440 #
2441 # Note that completed Operation resources have a limited
2442 # retention period.
2443 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2444 # Not present otherwise.
2445 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2446 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2447 # set when the operation is created.
2448 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2449 # text format.
2450 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2451 # this field will be populated.
2452 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2453 # operation.
2454 {
2455 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2456 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2457 # details. There is a set of defined message types to use for providing
2458 # details.The syntax depends on the error code. For example,
2459 # QuotaExceededInfo will have details when the error code is
2460 # QUOTA_EXCEEDED.
2461 {
2462 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2463 #
2464 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2465 # is not enabled:
2466 #
2467 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2468 # &quot;domain&quot;: &quot;googleapis.com&quot;
2469 # &quot;metadata&quot;: {
2470 # &quot;resource&quot;: &quot;projects/123&quot;,
2471 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2472 # }
2473 # }
2474 #
2475 # This response indicates that the pubsub.googleapis.com API is not enabled.
2476 #
2477 # Example of an error that is returned when attempting to create a Spanner
2478 # instance in a region that is out of stock:
2479 #
2480 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2481 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2482 # &quot;metadata&quot;: {
2483 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2484 # }
2485 # }
2486 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2487 # is typically the registered service name of the tool or product that
2488 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2489 # generated by some common infrastructure, the error domain must be a
2490 # globally unique value that identifies the infrastructure. For Google API
2491 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2492 &quot;metadatas&quot;: { # Additional structured details about this error.
2493 #
2494 # Keys must match a regular expression of `a-z+` but should
2495 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2496 # length. When identifying the current value of an exceeded limit, the units
2497 # should be contained in the key, not the value. For example, rather than
2498 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2499 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2500 # instances that can be created in a single (batch) request.
2501 &quot;a_key&quot;: &quot;A String&quot;,
2502 },
2503 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2504 # proximate cause of the error. Error reasons are unique within a particular
2505 # domain of errors. This should be at most 63 characters and match a
2506 # regular expression of `A-Z+[A-Z0-9]`, which represents
2507 # UPPER_SNAKE_CASE.
2508 },
2509 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2510 #
2511 # For example, if a quota check failed with an error indicating the calling
2512 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2513 # directly to the right place in the developer console to flip the bit.
2514 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2515 { # Describes a URL link.
2516 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2517 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2518 },
2519 ],
2520 },
2521 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2522 # which can be attached to an RPC error.
2523 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2524 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2525 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2526 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2527 },
2528 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2529 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2530 &quot;a_key&quot;: &quot;A String&quot;,
2531 },
2532 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2533 # type or metric.
2534 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2535 # or metric.
2536 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2537 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2538 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2539 },
2540 },
2541 ],
2542 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2543 # This property is optional.
2544 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2545 },
2546 ],
2547 },
2548 &quot;getVersionOperationMetadata&quot;: {
2549 &quot;inlineSbomInfo&quot;: {
2550 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2551 # appropriate identifiers.
2552 &quot;a_key&quot;: &quot;A String&quot;,
2553 },
2554 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2555 # identifiers.
2556 &quot;a_key&quot;: &quot;A String&quot;,
2557 },
2558 },
2559 },
2560 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2561 # message that was returned, such as `NOT FOUND`.
2562 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2563 # status code that was returned. For example, a `404` means the
2564 # resource was not found.
2565 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2566 # defined by the server.
2567 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2568 # This value is inRFC3339
2569 # text format.
2570 &quot;instancesBulkInsertOperationMetadata&quot;: {
2571 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2572 # Example key: zones/us-central1-a
2573 &quot;a_key&quot;: {
2574 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2575 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2576 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2577 # error.
2578 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2579 # if the flow is rolling forward or rolling back.
2580 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2581 },
2582 },
2583 },
2584 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2585 # Operation resources.
2586 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2587 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2588 # group of operations results from a `bulkInsert` API request.
2589 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2590 # `update`, or `delete`, and so on.
2591 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2592 # There is no requirement that this be linear or support any granularity of
2593 # operations. This should not be used to guess when the operation will be
2594 # complete. This number should monotonically increase as the operation
2595 # progresses.
2596 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2597 # applicable when performing regional operations.
2598 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2599 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2600 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2601 # this field will contain information on all underlying zonal actions and
2602 # their state.
2603 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2604 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2605 # Example key: zones/us-central1-a
2606 &quot;a_key&quot;: {
2607 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2608 # populated.
2609 # different programming environments, including REST APIs and RPC APIs. It is
2610 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2611 # three pieces of data: error code, error message, and error details.
2612 #
2613 # You can find out more about this error model and how to work with it in the
2614 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2615 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2616 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2617 # message types for APIs to use.
2618 {
2619 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2620 },
2621 ],
2622 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2623 # user-facing error message should be localized and sent in the
2624 # google.rpc.Status.details field, or localized by the client.
2625 },
2626 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2627 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2628 },
2629 },
2630 },
2631 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2632 # This value is inRFC3339
2633 # text format.
2634 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2635 # following:
2636 # `PENDING`, `RUNNING`, or `DONE`.
2637 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2638 # operation.
2639 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2640 # of the target resource.
2641 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2642 # operations related to creating a snapshot, this points to the disk
2643 # that the snapshot was created from.
2644 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2645 # `[email protected]` or
2646 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2647 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2648 # operation, this field will be populated.
2649 {
2650 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2651 # Engine returns NO_RESULTS_ON_PAGE if there
2652 # are no results in the response.
2653 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2654 # value format. For example:
2655 #
2656 # &quot;data&quot;: [
2657 # {
2658 # &quot;key&quot;: &quot;scope&quot;,
2659 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2660 # }
2661 {
2662 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2663 # returned. For example, for warnings where there are no results in a list
2664 # request for a particular zone, this key might be scope and
2665 # the key value might be the zone name. Other examples might be a key
2666 # indicating a deprecated resource and a suggested replacement, or a
2667 # warning about invalid network settings (for example, if an instance
2668 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2669 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2670 },
2671 ],
2672 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2673 },
2674 ],
2675 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2676 # applicable when performing per-zone operations.
2677 }</pre>
2678 </div>
2679
2680 <div class="method">
2681 <code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None, x__xgafv=None)</code>
2682 <pre>Changes a backup target pool&#x27;s configurations.
2683
2684 Args:
2685 project: string, Project ID for this request. (required)
2686 region: string, Name of the region scoping this request. (required)
2687 targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
2688 body: object, The request body.
2689 The object takes the form of:
2690
2691 {
2692 &quot;target&quot;: &quot;A String&quot;,
2693 }
2694
2695 failoverRatio: number, New failoverRatio value for the target pool.
2696 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2697 that if you must retry your request, the server will know to ignore the
2698 request if it has already been completed.
2699
2700 For example, consider a situation where you make an initial request and
2701 the request times out. If you make the request again with the same
2702 request ID, the server can check if original operation with the same
2703 request ID was received, and if so, will ignore the second request. This
2704 prevents clients from accidentally creating duplicate commitments.
2705
2706 The request ID must be
2707 a valid UUID with the exception that zero UUID is not supported
2708 (00000000-0000-0000-0000-000000000000).
2709 x__xgafv: string, V1 error format.
2710 Allowed values
2711 1 - v1 error format
2712 2 - v2 error format
2713
2714 Returns:
2715 An object of the form:
2716
2717 { # Represents an Operation resource.
2718 #
2719 # Google Compute Engine has three Operation resources:
2720 #
2721 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2722 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2723 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2724 #
2725 # You can use an operation resource to manage asynchronous API requests.
2726 # For more information, readHandling
2727 # API responses.
2728 #
2729 # Operations can be global, regional or zonal.
2730 #
2731 # - For global operations, use the `globalOperations`
2732 # resource.
2733 # - For regional operations, use the
2734 # `regionOperations` resource.
2735 # - For zonal operations, use
2736 # the `zoneOperations` resource.
2737 #
2738 #
2739 #
2740 # For more information, read
2741 # Global, Regional, and Zonal Resources.
2742 #
2743 # Note that completed Operation resources have a limited
2744 # retention period.
2745 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2746 # Not present otherwise.
2747 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2748 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2749 # set when the operation is created.
2750 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2751 # text format.
2752 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2753 # this field will be populated.
2754 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2755 # operation.
2756 {
2757 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2758 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2759 # details. There is a set of defined message types to use for providing
2760 # details.The syntax depends on the error code. For example,
2761 # QuotaExceededInfo will have details when the error code is
2762 # QUOTA_EXCEEDED.
2763 {
2764 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2765 #
2766 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2767 # is not enabled:
2768 #
2769 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2770 # &quot;domain&quot;: &quot;googleapis.com&quot;
2771 # &quot;metadata&quot;: {
2772 # &quot;resource&quot;: &quot;projects/123&quot;,
2773 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2774 # }
2775 # }
2776 #
2777 # This response indicates that the pubsub.googleapis.com API is not enabled.
2778 #
2779 # Example of an error that is returned when attempting to create a Spanner
2780 # instance in a region that is out of stock:
2781 #
2782 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2783 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2784 # &quot;metadata&quot;: {
2785 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2786 # }
2787 # }
2788 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2789 # is typically the registered service name of the tool or product that
2790 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2791 # generated by some common infrastructure, the error domain must be a
2792 # globally unique value that identifies the infrastructure. For Google API
2793 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2794 &quot;metadatas&quot;: { # Additional structured details about this error.
2795 #
2796 # Keys must match a regular expression of `a-z+` but should
2797 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2798 # length. When identifying the current value of an exceeded limit, the units
2799 # should be contained in the key, not the value. For example, rather than
2800 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2801 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2802 # instances that can be created in a single (batch) request.
2803 &quot;a_key&quot;: &quot;A String&quot;,
2804 },
2805 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2806 # proximate cause of the error. Error reasons are unique within a particular
2807 # domain of errors. This should be at most 63 characters and match a
2808 # regular expression of `A-Z+[A-Z0-9]`, which represents
2809 # UPPER_SNAKE_CASE.
2810 },
2811 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2812 #
2813 # For example, if a quota check failed with an error indicating the calling
2814 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2815 # directly to the right place in the developer console to flip the bit.
2816 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2817 { # Describes a URL link.
2818 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2819 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2820 },
2821 ],
2822 },
2823 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2824 # which can be attached to an RPC error.
2825 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2826 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2827 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2828 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2829 },
2830 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2831 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2832 &quot;a_key&quot;: &quot;A String&quot;,
2833 },
2834 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2835 # type or metric.
2836 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2837 # or metric.
2838 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2839 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2840 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2841 },
2842 },
2843 ],
2844 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2845 # This property is optional.
2846 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2847 },
2848 ],
2849 },
2850 &quot;getVersionOperationMetadata&quot;: {
2851 &quot;inlineSbomInfo&quot;: {
2852 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2853 # appropriate identifiers.
2854 &quot;a_key&quot;: &quot;A String&quot;,
2855 },
2856 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2857 # identifiers.
2858 &quot;a_key&quot;: &quot;A String&quot;,
2859 },
2860 },
2861 },
2862 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2863 # message that was returned, such as `NOT FOUND`.
2864 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2865 # status code that was returned. For example, a `404` means the
2866 # resource was not found.
2867 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2868 # defined by the server.
2869 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2870 # This value is inRFC3339
2871 # text format.
2872 &quot;instancesBulkInsertOperationMetadata&quot;: {
2873 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2874 # Example key: zones/us-central1-a
2875 &quot;a_key&quot;: {
2876 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2877 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2878 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2879 # error.
2880 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2881 # if the flow is rolling forward or rolling back.
2882 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2883 },
2884 },
2885 },
2886 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2887 # Operation resources.
2888 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2889 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2890 # group of operations results from a `bulkInsert` API request.
2891 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2892 # `update`, or `delete`, and so on.
2893 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2894 # There is no requirement that this be linear or support any granularity of
2895 # operations. This should not be used to guess when the operation will be
2896 # complete. This number should monotonically increase as the operation
2897 # progresses.
2898 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2899 # applicable when performing regional operations.
2900 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2901 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2902 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2903 # this field will contain information on all underlying zonal actions and
2904 # their state.
2905 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2906 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2907 # Example key: zones/us-central1-a
2908 &quot;a_key&quot;: {
2909 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2910 # populated.
2911 # different programming environments, including REST APIs and RPC APIs. It is
2912 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2913 # three pieces of data: error code, error message, and error details.
2914 #
2915 # You can find out more about this error model and how to work with it in the
2916 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2917 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2918 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2919 # message types for APIs to use.
2920 {
2921 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2922 },
2923 ],
2924 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2925 # user-facing error message should be localized and sent in the
2926 # google.rpc.Status.details field, or localized by the client.
2927 },
2928 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2929 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2930 },
2931 },
2932 },
2933 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2934 # This value is inRFC3339
2935 # text format.
2936 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2937 # following:
2938 # `PENDING`, `RUNNING`, or `DONE`.
2939 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2940 # operation.
2941 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2942 # of the target resource.
2943 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2944 # operations related to creating a snapshot, this points to the disk
2945 # that the snapshot was created from.
2946 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2947 # `[email protected]` or
2948 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2949 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2950 # operation, this field will be populated.
2951 {
2952 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2953 # Engine returns NO_RESULTS_ON_PAGE if there
2954 # are no results in the response.
2955 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2956 # value format. For example:
2957 #
2958 # &quot;data&quot;: [
2959 # {
2960 # &quot;key&quot;: &quot;scope&quot;,
2961 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2962 # }
2963 {
2964 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2965 # returned. For example, for warnings where there are no results in a list
2966 # request for a particular zone, this key might be scope and
2967 # the key value might be the zone name. Other examples might be a key
2968 # indicating a deprecated resource and a suggested replacement, or a
2969 # warning about invalid network settings (for example, if an instance
2970 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2971 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2972 },
2973 ],
2974 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2975 },
2976 ],
2977 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2978 # applicable when performing per-zone operations.
2979 }</pre>
2980 </div>
2981
2982 <div class="method">
2983 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, region, targetPool, body=None, requestId=None, x__xgafv=None)</code>
2984 <pre>Sets the Google Cloud Armor security policy for the specified target pool.
2985 For more information, seeGoogle
2986 Cloud Armor Overview
2987
2988 Args:
2989 project: string, Project ID for this request. (required)
2990 region: string, Name of the region scoping this request. (required)
2991 targetPool: string, Name of the TargetPool resource to which the security policy should be
2992 set. The name should conform to RFC1035. (required)
2993 body: object, The request body.
2994 The object takes the form of:
2995
2996 {
2997 &quot;securityPolicy&quot;: &quot;A String&quot;,
2998 }
2999
3000 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3001 that if you must retry your request, the server will know to ignore the
3002 request if it has already been completed.
3003
3004 For example, consider a situation where you make an initial request and
3005 the request times out. If you make the request again with the same
3006 request ID, the server can check if original operation with the same
3007 request ID was received, and if so, will ignore the second request. This
3008 prevents clients from accidentally creating duplicate commitments.
3009
3010 The request ID must be
3011 a valid UUID with the exception that zero UUID is not supported
3012 (00000000-0000-0000-0000-000000000000).
3013 x__xgafv: string, V1 error format.
3014 Allowed values
3015 1 - v1 error format
3016 2 - v2 error format
3017
3018 Returns:
3019 An object of the form:
3020
3021 { # Represents an Operation resource.
3022 #
3023 # Google Compute Engine has three Operation resources:
3024 #
3025 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3026 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3027 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3028 #
3029 # You can use an operation resource to manage asynchronous API requests.
3030 # For more information, readHandling
3031 # API responses.
3032 #
3033 # Operations can be global, regional or zonal.
3034 #
3035 # - For global operations, use the `globalOperations`
3036 # resource.
3037 # - For regional operations, use the
3038 # `regionOperations` resource.
3039 # - For zonal operations, use
3040 # the `zoneOperations` resource.
3041 #
3042 #
3043 #
3044 # For more information, read
3045 # Global, Regional, and Zonal Resources.
3046 #
3047 # Note that completed Operation resources have a limited
3048 # retention period.
3049 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3050 # Not present otherwise.
3051 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3052 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3053 # set when the operation is created.
3054 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3055 # text format.
3056 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3057 # this field will be populated.
3058 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3059 # operation.
3060 {
3061 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3062 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3063 # details. There is a set of defined message types to use for providing
3064 # details.The syntax depends on the error code. For example,
3065 # QuotaExceededInfo will have details when the error code is
3066 # QUOTA_EXCEEDED.
3067 {
3068 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3069 #
3070 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3071 # is not enabled:
3072 #
3073 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3074 # &quot;domain&quot;: &quot;googleapis.com&quot;
3075 # &quot;metadata&quot;: {
3076 # &quot;resource&quot;: &quot;projects/123&quot;,
3077 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3078 # }
3079 # }
3080 #
3081 # This response indicates that the pubsub.googleapis.com API is not enabled.
3082 #
3083 # Example of an error that is returned when attempting to create a Spanner
3084 # instance in a region that is out of stock:
3085 #
3086 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3087 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3088 # &quot;metadata&quot;: {
3089 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3090 # }
3091 # }
3092 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3093 # is typically the registered service name of the tool or product that
3094 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3095 # generated by some common infrastructure, the error domain must be a
3096 # globally unique value that identifies the infrastructure. For Google API
3097 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3098 &quot;metadatas&quot;: { # Additional structured details about this error.
3099 #
3100 # Keys must match a regular expression of `a-z+` but should
3101 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3102 # length. When identifying the current value of an exceeded limit, the units
3103 # should be contained in the key, not the value. For example, rather than
3104 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3105 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3106 # instances that can be created in a single (batch) request.
3107 &quot;a_key&quot;: &quot;A String&quot;,
3108 },
3109 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3110 # proximate cause of the error. Error reasons are unique within a particular
3111 # domain of errors. This should be at most 63 characters and match a
3112 # regular expression of `A-Z+[A-Z0-9]`, which represents
3113 # UPPER_SNAKE_CASE.
3114 },
3115 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3116 #
3117 # For example, if a quota check failed with an error indicating the calling
3118 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3119 # directly to the right place in the developer console to flip the bit.
3120 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3121 { # Describes a URL link.
3122 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3123 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3124 },
3125 ],
3126 },
3127 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3128 # which can be attached to an RPC error.
3129 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3130 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3131 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3132 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3133 },
3134 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3135 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3136 &quot;a_key&quot;: &quot;A String&quot;,
3137 },
3138 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3139 # type or metric.
3140 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3141 # or metric.
3142 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3143 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3144 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3145 },
3146 },
3147 ],
3148 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3149 # This property is optional.
3150 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3151 },
3152 ],
3153 },
3154 &quot;getVersionOperationMetadata&quot;: {
3155 &quot;inlineSbomInfo&quot;: {
3156 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3157 # appropriate identifiers.
3158 &quot;a_key&quot;: &quot;A String&quot;,
3159 },
3160 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3161 # identifiers.
3162 &quot;a_key&quot;: &quot;A String&quot;,
3163 },
3164 },
3165 },
3166 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3167 # message that was returned, such as `NOT FOUND`.
3168 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3169 # status code that was returned. For example, a `404` means the
3170 # resource was not found.
3171 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3172 # defined by the server.
3173 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3174 # This value is inRFC3339
3175 # text format.
3176 &quot;instancesBulkInsertOperationMetadata&quot;: {
3177 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3178 # Example key: zones/us-central1-a
3179 &quot;a_key&quot;: {
3180 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3181 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3182 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3183 # error.
3184 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3185 # if the flow is rolling forward or rolling back.
3186 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3187 },
3188 },
3189 },
3190 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3191 # Operation resources.
3192 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3193 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3194 # group of operations results from a `bulkInsert` API request.
3195 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3196 # `update`, or `delete`, and so on.
3197 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3198 # There is no requirement that this be linear or support any granularity of
3199 # operations. This should not be used to guess when the operation will be
3200 # complete. This number should monotonically increase as the operation
3201 # progresses.
3202 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3203 # applicable when performing regional operations.
3204 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3205 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3206 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3207 # this field will contain information on all underlying zonal actions and
3208 # their state.
3209 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3210 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3211 # Example key: zones/us-central1-a
3212 &quot;a_key&quot;: {
3213 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
3214 # populated.
3215 # different programming environments, including REST APIs and RPC APIs. It is
3216 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3217 # three pieces of data: error code, error message, and error details.
3218 #
3219 # You can find out more about this error model and how to work with it in the
3220 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3221 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3222 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3223 # message types for APIs to use.
3224 {
3225 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3226 },
3227 ],
3228 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3229 # user-facing error message should be localized and sent in the
3230 # google.rpc.Status.details field, or localized by the client.
3231 },
3232 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3233 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3234 },
3235 },
3236 },
3237 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3238 # This value is inRFC3339
3239 # text format.
3240 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3241 # following:
3242 # `PENDING`, `RUNNING`, or `DONE`.
3243 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3244 # operation.
3245 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3246 # of the target resource.
3247 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3248 # operations related to creating a snapshot, this points to the disk
3249 # that the snapshot was created from.
3250 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3251 # `[email protected]` or
3252 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3253 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3254 # operation, this field will be populated.
3255 {
3256 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3257 # Engine returns NO_RESULTS_ON_PAGE if there
3258 # are no results in the response.
3259 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3260 # value format. For example:
3261 #
3262 # &quot;data&quot;: [
3263 # {
3264 # &quot;key&quot;: &quot;scope&quot;,
3265 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3266 # }
3267 {
3268 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3269 # returned. For example, for warnings where there are no results in a list
3270 # request for a particular zone, this key might be scope and
3271 # the key value might be the zone name. Other examples might be a key
3272 # indicating a deprecated resource and a suggested replacement, or a
3273 # warning about invalid network settings (for example, if an instance
3274 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3275 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3276 },
3277 ],
3278 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3279 },
3280 ],
3281 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3282 # applicable when performing per-zone operations.
3283 }</pre>
3284 </div>
3285
3286 <div class="method">
3287 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
3288 <pre>Returns permissions that a caller has on the specified resource.
3289
3290 Args:
3291 project: string, Project ID for this request. (required)
3292 region: string, The name of the region for this request. (required)
3293 resource: string, Name or id of the resource for this request. (required)
3294 body: object, The request body.
3295 The object takes the form of:
3296
3297 {
3298 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
3299 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
3300 &quot;A String&quot;,
3301 ],
3302 }
3303
3304 x__xgafv: string, V1 error format.
3305 Allowed values
3306 1 - v1 error format
3307 2 - v2 error format
3308
3309 Returns:
3310 An object of the form:
3311
3312 {
3313 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3314 # allowed.
3315 &quot;A String&quot;,
3316 ],
3317 }</pre>
3318 </div>
3319
3320 </body></html>