Debian Codegraph @

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