Debian Codegraph @

docs/dyn/compute_v1.regionHealthCheckServices.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.regionHealthCheckServices.html">regionHealthCheckServices</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <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>
79 <p class="firstline">Retrieves the list of all HealthCheckService resources,</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, healthCheckService, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified regional HealthCheckService.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, region, healthCheckService, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified regional HealthCheckService resource.</p>
92 <p class="toc_element">
93 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Creates a regional HealthCheckService resource in the</p>
95 <p class="toc_element">
96 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Lists all the HealthCheckService resources that have been</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#patch">patch(project, region, healthCheckService, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates the specified regional HealthCheckService resource</p>
104 <p class="toc_element">
105 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <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>
110 <pre>Retrieves the list of all HealthCheckService resources,
111 regional and global, available to the specified project.
112
113 To prevent failure, it is recommended that you set the
114 `returnPartialSuccess` parameter to `true`.
115
116 Args:
117 project: string, Name of the project scoping this request. (required)
118 filter: string, A filter expression that filters resources listed in the response. Most
119 Compute resources support two types of filter expressions:
120 expressions that support regular expressions and expressions that follow
121 API improvement proposal AIP-160.
122 These two types of filter expressions cannot be mixed in one request.
123
124 If you want to use AIP-160, your expression must specify the field name, an
125 operator, and the value that you want to use for filtering. The value
126 must be a string, a number, or a boolean. The operator
127 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
128
129 For example, if you are filtering Compute Engine instances, you can
130 exclude instances named `example-instance` by specifying
131 `name != example-instance`.
132
133 The `:*` comparison can be used to test whether a key has been defined.
134 For example, to find all objects with `owner` label use:
135 ```
136 labels.owner:*
137 ```
138
139 You can also filter nested fields. For example, you could specify
140 `scheduling.automaticRestart = false` to include instances only
141 if they are not scheduled for automatic restarts. You can use filtering
142 on nested fields to filter based onresource labels.
143
144 To filter on multiple expressions, provide each separate expression within
145 parentheses. For example:
146 ```
147 (scheduling.automaticRestart = true)
148 (cpuPlatform = &quot;Intel Skylake&quot;)
149 ```
150 By default, each expression is an `AND` expression. However, you
151 can include `AND` and `OR` expressions explicitly.
152 For example:
153 ```
154 (cpuPlatform = &quot;Intel Skylake&quot;) OR
155 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
156 (scheduling.automaticRestart = true)
157 ```
158
159 If you want to use a regular expression, use the `eq` (equal) or `ne`
160 (not equal) operator against a single un-parenthesized expression with or
161 without quotes or against multiple parenthesized expressions. Examples:
162
163 `fieldname eq unquoted literal`
164 `fieldname eq &#x27;single quoted literal&#x27;`
165 `fieldname eq &quot;double quoted literal&quot;`
166 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
167
168 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
169 The literal value must match the entire field.
170
171 For example, to filter for instances that do not end with name &quot;instance&quot;,
172 you would use `name ne .*instance`.
173
174 You cannot combine constraints on multiple fields using regular
175 expressions.
176 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
177 global) should be included in the response. For new resource types added
178 after this field, the flag has no effect as new resource types will always
179 include every visible scope for each scope type in response. For resource
180 types which predate this field, if this flag is omitted or false, only
181 scopes of the scope types where the resource type is expected to be found
182 will be included.
183 maxResults: integer, The maximum number of results per page that should be returned.
184 If the number of available results is larger than `maxResults`,
185 Compute Engine returns a `nextPageToken` that can be used to get
186 the next page of results in subsequent list requests. Acceptable values are
187 `0` to `500`, inclusive. (Default: `500`)
188 orderBy: string, Sorts list results by a certain order. By default, results
189 are returned in alphanumerical order based on the resource name.
190
191 You can also sort results in descending order based on the creation
192 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
193 results based on the `creationTimestamp` field in
194 reverse chronological order (newest result first). Use this to sort
195 resources like operations so that the newest operation is returned first.
196
197 Currently, only sorting by `name` or
198 `creationTimestamp desc` is supported.
199 pageToken: string, Specifies a page token to use. Set `pageToken` to the
200 `nextPageToken` returned by a previous list request to get
201 the next page of results.
202 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
203 of failure. The default value is false.
204
205 For example, when partial success behavior is enabled, aggregatedList for a
206 single zone scope either returns all resources in the zone or no resources,
207 with an error code.
208 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
209 aggregated list request is invoked for subnetworks list-usable api.
210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215 Returns:
216 An object of the form:
217
218 { # Contains a list of HealthCheckServicesScopedList.
219 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
220 &quot;items&quot;: { # A list of HealthCheckServicesScopedList resources.
221 &quot;a_key&quot;: { # Name of the scope containing this set of HealthCheckServices.
222 &quot;resources&quot;: [ # A list of HealthCheckServices contained in this scope.
223 { # Represents a Health-Check as a Service resource.
224 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
225 # text format.
226 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
227 # create the resource.
228 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
229 # This field is used in optimistic locking. This field will be ignored when
230 # inserting a HealthCheckService. An up-to-date fingerprint must
231 # be provided in order to patch/update the HealthCheckService; Otherwise, the
232 # request will fail with error 412 conditionNotMet. To see the
233 # latest fingerprint, make a get() request to retrieve the
234 # HealthCheckService.
235 &quot;healthChecks&quot;: [ # A list of URLs to the HealthCheck resources. Must have
236 # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
237 # regional HealthCheckService, theHealthCheck must be regional and in the same
238 # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
239 # global HealthChecks must specify sourceRegions,
240 # and HealthChecks that specify sourceRegions can
241 # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
242 &quot;A String&quot;,
243 ],
244 &quot;healthStatusAggregationPolicy&quot;: &quot;A String&quot;, # Optional. Policy for how the results from multiple health checks
245 # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
246 # if unspecified.
247 #
248 # - NO_AGGREGATION. An EndpointHealth message is
249 # returned for each pair in the health check
250 # service.
251 # - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
252 #
253 # .
254 # This is only allowed with regional HealthCheckService.
255 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
256 # defined by the server.
257 &quot;kind&quot;: &quot;compute#healthCheckService&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
258 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long, and comply
259 # with RFC1035. Specifically, the name must be 1-63 characters
260 # long and match the regular expression
261 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
262 # must be a lowercase letter, and all following characters must be a dash,
263 # lowercase letter, or digit, except the last character, which cannot be a
264 # dash.
265 &quot;networkEndpointGroups&quot;: [ # A list of URLs to the NetworkEndpointGroup
266 # resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in
267 # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
268 # must be global INTERNET_IP_PORT.
269 &quot;A String&quot;,
270 ],
271 &quot;notificationEndpoints&quot;: [ # A list of URLs to the NotificationEndpoint
272 # resources. Must not have more than 10. A list of endpoints for
273 # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
274 # same region. For global HealthCheckService,NotificationEndpoint must be global.
275 &quot;A String&quot;,
276 ],
277 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the health check service
278 # resides. This field is not applicable to global health check services.
279 # You must specify this field as part of the HTTP request URL. It is
280 # not settable as a field in the request body.
281 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
282 },
283 ],
284 &quot;warning&quot;: { # Informational warning which replaces the list of
285 # backend services when the list is empty.
286 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
287 # Engine returns NO_RESULTS_ON_PAGE if there
288 # are no results in the response.
289 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
290 # value format. For example:
291 #
292 # &quot;data&quot;: [
293 # {
294 # &quot;key&quot;: &quot;scope&quot;,
295 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
296 # }
297 {
298 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
299 # returned. For example, for warnings where there are no results in a list
300 # request for a particular zone, this key might be scope and
301 # the key value might be the zone name. Other examples might be a key
302 # indicating a deprecated resource and a suggested replacement, or a
303 # warning about invalid network settings (for example, if an instance
304 # attempts to perform IP forwarding but is not enabled for IP forwarding).
305 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
306 },
307 ],
308 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
309 },
310 },
311 },
312 &quot;kind&quot;: &quot;compute#healthCheckServiceAggregatedList&quot;, # Output only. Type of resource.
313 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
314 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
315 # the query parameter pageToken in the next list request.
316 # Subsequent list requests will have their own nextPageToken to
317 # continue paging through the results.
318 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
319 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
320 &quot;A String&quot;,
321 ],
322 &quot;warning&quot;: { # [Output Only] Informational warning message.
323 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
324 # Engine returns NO_RESULTS_ON_PAGE if there
325 # are no results in the response.
326 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
327 # value format. For example:
328 #
329 # &quot;data&quot;: [
330 # {
331 # &quot;key&quot;: &quot;scope&quot;,
332 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
333 # }
334 {
335 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
336 # returned. For example, for warnings where there are no results in a list
337 # request for a particular zone, this key might be scope and
338 # the key value might be the zone name. Other examples might be a key
339 # indicating a deprecated resource and a suggested replacement, or a
340 # warning about invalid network settings (for example, if an instance
341 # attempts to perform IP forwarding but is not enabled for IP forwarding).
342 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
343 },
344 ],
345 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
346 },
347 }</pre>
348 </div>
349
350 <div class="method">
351 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
352 <pre>Retrieves the next page of results.
353
354 Args:
355 previous_request: The request for the previous page. (required)
356 previous_response: The response from the request for the previous page. (required)
357
358 Returns:
359 A request object that you can call &#x27;execute()&#x27; on to request the next
360 page. Returns None if there are no more items in the collection.
361 </pre>
362 </div>
363
364 <div class="method">
365 <code class="details" id="close">close()</code>
366 <pre>Close httplib2 connections.</pre>
367 </div>
368
369 <div class="method">
370 <code class="details" id="delete">delete(project, region, healthCheckService, requestId=None, x__xgafv=None)</code>
371 <pre>Deletes the specified regional HealthCheckService.
372
373 Args:
374 project: string, Project ID for this request. (required)
375 region: string, Name of the region scoping this request. (required)
376 healthCheckService: string, Name of the HealthCheckService to delete. The name
377 must be 1-63 characters long, and comply with RFC1035. (required)
378 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
379 that if you must retry your request, the server will know to ignore the
380 request if it has already been completed.
381
382 For example, consider a situation where you make an initial request and
383 the request times out. If you make the request again with the same
384 request ID, the server can check if original operation with the same
385 request ID was received, and if so, will ignore the second request. This
386 prevents clients from accidentally creating duplicate commitments.
387
388 The request ID must be
389 a valid UUID with the exception that zero UUID is not supported
390 (00000000-0000-0000-0000-000000000000).
391 x__xgafv: string, V1 error format.
392 Allowed values
393 1 - v1 error format
394 2 - v2 error format
395
396 Returns:
397 An object of the form:
398
399 { # Represents an Operation resource.
400 #
401 # Google Compute Engine has three Operation resources:
402 #
403 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
404 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
405 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
406 #
407 # You can use an operation resource to manage asynchronous API requests.
408 # For more information, readHandling
409 # API responses.
410 #
411 # Operations can be global, regional or zonal.
412 #
413 # - For global operations, use the `globalOperations`
414 # resource.
415 # - For regional operations, use the
416 # `regionOperations` resource.
417 # - For zonal operations, use
418 # the `zoneOperations` resource.
419 #
420 #
421 #
422 # For more information, read
423 # Global, Regional, and Zonal Resources.
424 #
425 # Note that completed Operation resources have a limited
426 # retention period.
427 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
428 # Not present otherwise.
429 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
430 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
431 # set when the operation is created.
432 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
433 # text format.
434 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
435 # this field will be populated.
436 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
437 # operation.
438 {
439 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
440 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
441 # details. There is a set of defined message types to use for providing
442 # details.The syntax depends on the error code. For example,
443 # QuotaExceededInfo will have details when the error code is
444 # QUOTA_EXCEEDED.
445 {
446 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
447 #
448 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
449 # is not enabled:
450 #
451 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
452 # &quot;domain&quot;: &quot;googleapis.com&quot;
453 # &quot;metadata&quot;: {
454 # &quot;resource&quot;: &quot;projects/123&quot;,
455 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
456 # }
457 # }
458 #
459 # This response indicates that the pubsub.googleapis.com API is not enabled.
460 #
461 # Example of an error that is returned when attempting to create a Spanner
462 # instance in a region that is out of stock:
463 #
464 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
465 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
466 # &quot;metadata&quot;: {
467 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
468 # }
469 # }
470 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
471 # is typically the registered service name of the tool or product that
472 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
473 # generated by some common infrastructure, the error domain must be a
474 # globally unique value that identifies the infrastructure. For Google API
475 # infrastructure, the error domain is &quot;googleapis.com&quot;.
476 &quot;metadatas&quot;: { # Additional structured details about this error.
477 #
478 # Keys must match a regular expression of `a-z+` but should
479 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
480 # length. When identifying the current value of an exceeded limit, the units
481 # should be contained in the key, not the value. For example, rather than
482 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
483 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
484 # instances that can be created in a single (batch) request.
485 &quot;a_key&quot;: &quot;A String&quot;,
486 },
487 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
488 # proximate cause of the error. Error reasons are unique within a particular
489 # domain of errors. This should be at most 63 characters and match a
490 # regular expression of `A-Z+[A-Z0-9]`, which represents
491 # UPPER_SNAKE_CASE.
492 },
493 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
494 #
495 # For example, if a quota check failed with an error indicating the calling
496 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
497 # directly to the right place in the developer console to flip the bit.
498 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
499 { # Describes a URL link.
500 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
501 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
502 },
503 ],
504 },
505 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
506 # which can be attached to an RPC error.
507 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
508 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
509 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
510 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
511 },
512 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
513 &quot;dimensions&quot;: { # The map holding related quota dimensions.
514 &quot;a_key&quot;: &quot;A String&quot;,
515 },
516 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
517 # type or metric.
518 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
519 # or metric.
520 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
521 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
522 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
523 },
524 },
525 ],
526 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
527 # This property is optional.
528 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
529 },
530 ],
531 },
532 &quot;getVersionOperationMetadata&quot;: {
533 &quot;inlineSbomInfo&quot;: {
534 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
535 # appropriate identifiers.
536 &quot;a_key&quot;: &quot;A String&quot;,
537 },
538 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
539 # identifiers.
540 &quot;a_key&quot;: &quot;A String&quot;,
541 },
542 },
543 },
544 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
545 # message that was returned, such as `NOT FOUND`.
546 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
547 # status code that was returned. For example, a `404` means the
548 # resource was not found.
549 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
550 # defined by the server.
551 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
552 # This value is inRFC3339
553 # text format.
554 &quot;instancesBulkInsertOperationMetadata&quot;: {
555 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
556 # Example key: zones/us-central1-a
557 &quot;a_key&quot;: {
558 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
559 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
560 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
561 # error.
562 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
563 # if the flow is rolling forward or rolling back.
564 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
565 },
566 },
567 },
568 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
569 # Operation resources.
570 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
571 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
572 # group of operations results from a `bulkInsert` API request.
573 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
574 # `update`, or `delete`, and so on.
575 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
576 # There is no requirement that this be linear or support any granularity of
577 # operations. This should not be used to guess when the operation will be
578 # complete. This number should monotonically increase as the operation
579 # progresses.
580 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
581 # applicable when performing regional operations.
582 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
583 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
584 # this field will contain information on all underlying zonal actions and
585 # their state.
586 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
587 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
588 # Example key: zones/us-central1-a
589 &quot;a_key&quot;: {
590 &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
591 # populated.
592 # different programming environments, including REST APIs and RPC APIs. It is
593 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
594 # three pieces of data: error code, error message, and error details.
595 #
596 # You can find out more about this error model and how to work with it in the
597 # [API Design Guide](https://cloud.google.com/apis/design/errors).
598 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
599 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
600 # message types for APIs to use.
601 {
602 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
603 },
604 ],
605 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
606 # user-facing error message should be localized and sent in the
607 # google.rpc.Status.details field, or localized by the client.
608 },
609 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
610 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
611 },
612 },
613 },
614 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
615 # This value is inRFC3339
616 # text format.
617 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
618 # following:
619 # `PENDING`, `RUNNING`, or `DONE`.
620 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
621 # operation.
622 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
623 # of the target resource.
624 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
625 # operations related to creating a snapshot, this points to the disk
626 # that the snapshot was created from.
627 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
628 # `[email protected]` or
629 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
630 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
631 # operation, this field will be populated.
632 {
633 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
634 # Engine returns NO_RESULTS_ON_PAGE if there
635 # are no results in the response.
636 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
637 # value format. For example:
638 #
639 # &quot;data&quot;: [
640 # {
641 # &quot;key&quot;: &quot;scope&quot;,
642 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
643 # }
644 {
645 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
646 # returned. For example, for warnings where there are no results in a list
647 # request for a particular zone, this key might be scope and
648 # the key value might be the zone name. Other examples might be a key
649 # indicating a deprecated resource and a suggested replacement, or a
650 # warning about invalid network settings (for example, if an instance
651 # attempts to perform IP forwarding but is not enabled for IP forwarding).
652 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
653 },
654 ],
655 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
656 },
657 ],
658 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
659 # applicable when performing per-zone operations.
660 }</pre>
661 </div>
662
663 <div class="method">
664 <code class="details" id="get">get(project, region, healthCheckService, x__xgafv=None)</code>
665 <pre>Returns the specified regional HealthCheckService resource.
666
667 Args:
668 project: string, Project ID for this request. (required)
669 region: string, Name of the region scoping this request. (required)
670 healthCheckService: string, Name of the HealthCheckService to update. The name
671 must be 1-63 characters long, and comply with RFC1035. (required)
672 x__xgafv: string, V1 error format.
673 Allowed values
674 1 - v1 error format
675 2 - v2 error format
676
677 Returns:
678 An object of the form:
679
680 { # Represents a Health-Check as a Service resource.
681 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
682 # text format.
683 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
684 # create the resource.
685 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
686 # This field is used in optimistic locking. This field will be ignored when
687 # inserting a HealthCheckService. An up-to-date fingerprint must
688 # be provided in order to patch/update the HealthCheckService; Otherwise, the
689 # request will fail with error 412 conditionNotMet. To see the
690 # latest fingerprint, make a get() request to retrieve the
691 # HealthCheckService.
692 &quot;healthChecks&quot;: [ # A list of URLs to the HealthCheck resources. Must have
693 # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
694 # regional HealthCheckService, theHealthCheck must be regional and in the same
695 # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
696 # global HealthChecks must specify sourceRegions,
697 # and HealthChecks that specify sourceRegions can
698 # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
699 &quot;A String&quot;,
700 ],
701 &quot;healthStatusAggregationPolicy&quot;: &quot;A String&quot;, # Optional. Policy for how the results from multiple health checks
702 # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
703 # if unspecified.
704 #
705 # - NO_AGGREGATION. An EndpointHealth message is
706 # returned for each pair in the health check
707 # service.
708 # - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
709 #
710 # .
711 # This is only allowed with regional HealthCheckService.
712 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
713 # defined by the server.
714 &quot;kind&quot;: &quot;compute#healthCheckService&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
715 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long, and comply
716 # with RFC1035. Specifically, the name must be 1-63 characters
717 # long and match the regular expression
718 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
719 # must be a lowercase letter, and all following characters must be a dash,
720 # lowercase letter, or digit, except the last character, which cannot be a
721 # dash.
722 &quot;networkEndpointGroups&quot;: [ # A list of URLs to the NetworkEndpointGroup
723 # resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in
724 # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
725 # must be global INTERNET_IP_PORT.
726 &quot;A String&quot;,
727 ],
728 &quot;notificationEndpoints&quot;: [ # A list of URLs to the NotificationEndpoint
729 # resources. Must not have more than 10. A list of endpoints for
730 # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
731 # same region. For global HealthCheckService,NotificationEndpoint must be global.
732 &quot;A String&quot;,
733 ],
734 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the health check service
735 # resides. This field is not applicable to global health check services.
736 # You must specify this field as part of the HTTP request URL. It is
737 # not settable as a field in the request body.
738 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
739 }</pre>
740 </div>
741
742 <div class="method">
743 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
744 <pre>Creates a regional HealthCheckService resource in the
745 specified project and region using the data included in the request.
746
747 Args:
748 project: string, Project ID for this request. (required)
749 region: string, Name of the region scoping this request. (required)
750 body: object, The request body.
751 The object takes the form of:
752
753 { # Represents a Health-Check as a Service resource.
754 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
755 # text format.
756 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
757 # create the resource.
758 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
759 # This field is used in optimistic locking. This field will be ignored when
760 # inserting a HealthCheckService. An up-to-date fingerprint must
761 # be provided in order to patch/update the HealthCheckService; Otherwise, the
762 # request will fail with error 412 conditionNotMet. To see the
763 # latest fingerprint, make a get() request to retrieve the
764 # HealthCheckService.
765 &quot;healthChecks&quot;: [ # A list of URLs to the HealthCheck resources. Must have
766 # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
767 # regional HealthCheckService, theHealthCheck must be regional and in the same
768 # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
769 # global HealthChecks must specify sourceRegions,
770 # and HealthChecks that specify sourceRegions can
771 # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
772 &quot;A String&quot;,
773 ],
774 &quot;healthStatusAggregationPolicy&quot;: &quot;A String&quot;, # Optional. Policy for how the results from multiple health checks
775 # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
776 # if unspecified.
777 #
778 # - NO_AGGREGATION. An EndpointHealth message is
779 # returned for each pair in the health check
780 # service.
781 # - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
782 #
783 # .
784 # This is only allowed with regional HealthCheckService.
785 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
786 # defined by the server.
787 &quot;kind&quot;: &quot;compute#healthCheckService&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
788 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long, and comply
789 # with RFC1035. Specifically, the name must be 1-63 characters
790 # long and match the regular expression
791 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
792 # must be a lowercase letter, and all following characters must be a dash,
793 # lowercase letter, or digit, except the last character, which cannot be a
794 # dash.
795 &quot;networkEndpointGroups&quot;: [ # A list of URLs to the NetworkEndpointGroup
796 # resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in
797 # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
798 # must be global INTERNET_IP_PORT.
799 &quot;A String&quot;,
800 ],
801 &quot;notificationEndpoints&quot;: [ # A list of URLs to the NotificationEndpoint
802 # resources. Must not have more than 10. A list of endpoints for
803 # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
804 # same region. For global HealthCheckService,NotificationEndpoint must be global.
805 &quot;A String&quot;,
806 ],
807 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the health check service
808 # resides. This field is not applicable to global health check services.
809 # You must specify this field as part of the HTTP request URL. It is
810 # not settable as a field in the request body.
811 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
812 }
813
814 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
815 that if you must retry your request, the server will know to ignore the
816 request if it has already been completed.
817
818 For example, consider a situation where you make an initial request and
819 the request times out. If you make the request again with the same
820 request ID, the server can check if original operation with the same
821 request ID was received, and if so, will ignore the second request. This
822 prevents clients from accidentally creating duplicate commitments.
823
824 The request ID must be
825 a valid UUID with the exception that zero UUID is not supported
826 (00000000-0000-0000-0000-000000000000).
827 x__xgafv: string, V1 error format.
828 Allowed values
829 1 - v1 error format
830 2 - v2 error format
831
832 Returns:
833 An object of the form:
834
835 { # Represents an Operation resource.
836 #
837 # Google Compute Engine has three Operation resources:
838 #
839 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
840 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
841 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
842 #
843 # You can use an operation resource to manage asynchronous API requests.
844 # For more information, readHandling
845 # API responses.
846 #
847 # Operations can be global, regional or zonal.
848 #
849 # - For global operations, use the `globalOperations`
850 # resource.
851 # - For regional operations, use the
852 # `regionOperations` resource.
853 # - For zonal operations, use
854 # the `zoneOperations` resource.
855 #
856 #
857 #
858 # For more information, read
859 # Global, Regional, and Zonal Resources.
860 #
861 # Note that completed Operation resources have a limited
862 # retention period.
863 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
864 # Not present otherwise.
865 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
866 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
867 # set when the operation is created.
868 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
869 # text format.
870 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
871 # this field will be populated.
872 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
873 # operation.
874 {
875 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
876 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
877 # details. There is a set of defined message types to use for providing
878 # details.The syntax depends on the error code. For example,
879 # QuotaExceededInfo will have details when the error code is
880 # QUOTA_EXCEEDED.
881 {
882 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
883 #
884 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
885 # is not enabled:
886 #
887 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
888 # &quot;domain&quot;: &quot;googleapis.com&quot;
889 # &quot;metadata&quot;: {
890 # &quot;resource&quot;: &quot;projects/123&quot;,
891 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
892 # }
893 # }
894 #
895 # This response indicates that the pubsub.googleapis.com API is not enabled.
896 #
897 # Example of an error that is returned when attempting to create a Spanner
898 # instance in a region that is out of stock:
899 #
900 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
901 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
902 # &quot;metadata&quot;: {
903 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
904 # }
905 # }
906 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
907 # is typically the registered service name of the tool or product that
908 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
909 # generated by some common infrastructure, the error domain must be a
910 # globally unique value that identifies the infrastructure. For Google API
911 # infrastructure, the error domain is &quot;googleapis.com&quot;.
912 &quot;metadatas&quot;: { # Additional structured details about this error.
913 #
914 # Keys must match a regular expression of `a-z+` but should
915 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
916 # length. When identifying the current value of an exceeded limit, the units
917 # should be contained in the key, not the value. For example, rather than
918 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
919 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
920 # instances that can be created in a single (batch) request.
921 &quot;a_key&quot;: &quot;A String&quot;,
922 },
923 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
924 # proximate cause of the error. Error reasons are unique within a particular
925 # domain of errors. This should be at most 63 characters and match a
926 # regular expression of `A-Z+[A-Z0-9]`, which represents
927 # UPPER_SNAKE_CASE.
928 },
929 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
930 #
931 # For example, if a quota check failed with an error indicating the calling
932 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
933 # directly to the right place in the developer console to flip the bit.
934 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
935 { # Describes a URL link.
936 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
937 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
938 },
939 ],
940 },
941 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
942 # which can be attached to an RPC error.
943 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
944 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
945 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
946 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
947 },
948 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
949 &quot;dimensions&quot;: { # The map holding related quota dimensions.
950 &quot;a_key&quot;: &quot;A String&quot;,
951 },
952 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
953 # type or metric.
954 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
955 # or metric.
956 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
957 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
958 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
959 },
960 },
961 ],
962 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
963 # This property is optional.
964 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
965 },
966 ],
967 },
968 &quot;getVersionOperationMetadata&quot;: {
969 &quot;inlineSbomInfo&quot;: {
970 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
971 # appropriate identifiers.
972 &quot;a_key&quot;: &quot;A String&quot;,
973 },
974 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
975 # identifiers.
976 &quot;a_key&quot;: &quot;A String&quot;,
977 },
978 },
979 },
980 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
981 # message that was returned, such as `NOT FOUND`.
982 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
983 # status code that was returned. For example, a `404` means the
984 # resource was not found.
985 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
986 # defined by the server.
987 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
988 # This value is inRFC3339
989 # text format.
990 &quot;instancesBulkInsertOperationMetadata&quot;: {
991 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
992 # Example key: zones/us-central1-a
993 &quot;a_key&quot;: {
994 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
995 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
996 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
997 # error.
998 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
999 # if the flow is rolling forward or rolling back.
1000 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1001 },
1002 },
1003 },
1004 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1005 # Operation resources.
1006 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1007 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1008 # group of operations results from a `bulkInsert` API request.
1009 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1010 # `update`, or `delete`, and so on.
1011 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1012 # There is no requirement that this be linear or support any granularity of
1013 # operations. This should not be used to guess when the operation will be
1014 # complete. This number should monotonically increase as the operation
1015 # progresses.
1016 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1017 # applicable when performing regional operations.
1018 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1019 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1020 # this field will contain information on all underlying zonal actions and
1021 # their state.
1022 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1023 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1024 # Example key: zones/us-central1-a
1025 &quot;a_key&quot;: {
1026 &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
1027 # populated.
1028 # different programming environments, including REST APIs and RPC APIs. It is
1029 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1030 # three pieces of data: error code, error message, and error details.
1031 #
1032 # You can find out more about this error model and how to work with it in the
1033 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1034 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1035 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1036 # message types for APIs to use.
1037 {
1038 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1039 },
1040 ],
1041 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1042 # user-facing error message should be localized and sent in the
1043 # google.rpc.Status.details field, or localized by the client.
1044 },
1045 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1046 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1047 },
1048 },
1049 },
1050 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1051 # This value is inRFC3339
1052 # text format.
1053 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1054 # following:
1055 # `PENDING`, `RUNNING`, or `DONE`.
1056 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1057 # operation.
1058 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1059 # of the target resource.
1060 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1061 # operations related to creating a snapshot, this points to the disk
1062 # that the snapshot was created from.
1063 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1064 # `[email protected]` or
1065 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1066 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1067 # operation, this field will be populated.
1068 {
1069 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1070 # Engine returns NO_RESULTS_ON_PAGE if there
1071 # are no results in the response.
1072 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1073 # value format. For example:
1074 #
1075 # &quot;data&quot;: [
1076 # {
1077 # &quot;key&quot;: &quot;scope&quot;,
1078 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1079 # }
1080 {
1081 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1082 # returned. For example, for warnings where there are no results in a list
1083 # request for a particular zone, this key might be scope and
1084 # the key value might be the zone name. Other examples might be a key
1085 # indicating a deprecated resource and a suggested replacement, or a
1086 # warning about invalid network settings (for example, if an instance
1087 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1088 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1089 },
1090 ],
1091 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1092 },
1093 ],
1094 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1095 # applicable when performing per-zone operations.
1096 }</pre>
1097 </div>
1098
1099 <div class="method">
1100 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1101 <pre>Lists all the HealthCheckService resources that have been
1102 configured for the specified project in the given region.
1103
1104 Args:
1105 project: string, Project ID for this request. (required)
1106 region: string, Name of the region scoping this request. (required)
1107 filter: string, A filter expression that filters resources listed in the response. Most
1108 Compute resources support two types of filter expressions:
1109 expressions that support regular expressions and expressions that follow
1110 API improvement proposal AIP-160.
1111 These two types of filter expressions cannot be mixed in one request.
1112
1113 If you want to use AIP-160, your expression must specify the field name, an
1114 operator, and the value that you want to use for filtering. The value
1115 must be a string, a number, or a boolean. The operator
1116 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1117
1118 For example, if you are filtering Compute Engine instances, you can
1119 exclude instances named `example-instance` by specifying
1120 `name != example-instance`.
1121
1122 The `:*` comparison can be used to test whether a key has been defined.
1123 For example, to find all objects with `owner` label use:
1124 ```
1125 labels.owner:*
1126 ```
1127
1128 You can also filter nested fields. For example, you could specify
1129 `scheduling.automaticRestart = false` to include instances only
1130 if they are not scheduled for automatic restarts. You can use filtering
1131 on nested fields to filter based onresource labels.
1132
1133 To filter on multiple expressions, provide each separate expression within
1134 parentheses. For example:
1135 ```
1136 (scheduling.automaticRestart = true)
1137 (cpuPlatform = &quot;Intel Skylake&quot;)
1138 ```
1139 By default, each expression is an `AND` expression. However, you
1140 can include `AND` and `OR` expressions explicitly.
1141 For example:
1142 ```
1143 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1144 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1145 (scheduling.automaticRestart = true)
1146 ```
1147
1148 If you want to use a regular expression, use the `eq` (equal) or `ne`
1149 (not equal) operator against a single un-parenthesized expression with or
1150 without quotes or against multiple parenthesized expressions. Examples:
1151
1152 `fieldname eq unquoted literal`
1153 `fieldname eq &#x27;single quoted literal&#x27;`
1154 `fieldname eq &quot;double quoted literal&quot;`
1155 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1156
1157 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1158 The literal value must match the entire field.
1159
1160 For example, to filter for instances that do not end with name &quot;instance&quot;,
1161 you would use `name ne .*instance`.
1162
1163 You cannot combine constraints on multiple fields using regular
1164 expressions.
1165 maxResults: integer, The maximum number of results per page that should be returned.
1166 If the number of available results is larger than `maxResults`,
1167 Compute Engine returns a `nextPageToken` that can be used to get
1168 the next page of results in subsequent list requests. Acceptable values are
1169 `0` to `500`, inclusive. (Default: `500`)
1170 orderBy: string, Sorts list results by a certain order. By default, results
1171 are returned in alphanumerical order based on the resource name.
1172
1173 You can also sort results in descending order based on the creation
1174 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1175 results based on the `creationTimestamp` field in
1176 reverse chronological order (newest result first). Use this to sort
1177 resources like operations so that the newest operation is returned first.
1178
1179 Currently, only sorting by `name` or
1180 `creationTimestamp desc` is supported.
1181 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1182 `nextPageToken` returned by a previous list request to get
1183 the next page of results.
1184 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1185 of failure. The default value is false.
1186
1187 For example, when partial success behavior is enabled, aggregatedList for a
1188 single zone scope either returns all resources in the zone or no resources,
1189 with an error code.
1190 x__xgafv: string, V1 error format.
1191 Allowed values
1192 1 - v1 error format
1193 2 - v2 error format
1194
1195 Returns:
1196 An object of the form:
1197
1198 {
1199 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
1200 &quot;items&quot;: [ # Output only. A list of HealthCheckService resources.
1201 { # Represents a Health-Check as a Service resource.
1202 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1203 # text format.
1204 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1205 # create the resource.
1206 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1207 # This field is used in optimistic locking. This field will be ignored when
1208 # inserting a HealthCheckService. An up-to-date fingerprint must
1209 # be provided in order to patch/update the HealthCheckService; Otherwise, the
1210 # request will fail with error 412 conditionNotMet. To see the
1211 # latest fingerprint, make a get() request to retrieve the
1212 # HealthCheckService.
1213 &quot;healthChecks&quot;: [ # A list of URLs to the HealthCheck resources. Must have
1214 # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
1215 # regional HealthCheckService, theHealthCheck must be regional and in the same
1216 # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
1217 # global HealthChecks must specify sourceRegions,
1218 # and HealthChecks that specify sourceRegions can
1219 # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
1220 &quot;A String&quot;,
1221 ],
1222 &quot;healthStatusAggregationPolicy&quot;: &quot;A String&quot;, # Optional. Policy for how the results from multiple health checks
1223 # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
1224 # if unspecified.
1225 #
1226 # - NO_AGGREGATION. An EndpointHealth message is
1227 # returned for each pair in the health check
1228 # service.
1229 # - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
1230 #
1231 # .
1232 # This is only allowed with regional HealthCheckService.
1233 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1234 # defined by the server.
1235 &quot;kind&quot;: &quot;compute#healthCheckService&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
1236 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long, and comply
1237 # with RFC1035. Specifically, the name must be 1-63 characters
1238 # long and match the regular expression
1239 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
1240 # must be a lowercase letter, and all following characters must be a dash,
1241 # lowercase letter, or digit, except the last character, which cannot be a
1242 # dash.
1243 &quot;networkEndpointGroups&quot;: [ # A list of URLs to the NetworkEndpointGroup
1244 # resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in
1245 # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
1246 # must be global INTERNET_IP_PORT.
1247 &quot;A String&quot;,
1248 ],
1249 &quot;notificationEndpoints&quot;: [ # A list of URLs to the NotificationEndpoint
1250 # resources. Must not have more than 10. A list of endpoints for
1251 # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
1252 # same region. For global HealthCheckService,NotificationEndpoint must be global.
1253 &quot;A String&quot;,
1254 ],
1255 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the health check service
1256 # resides. This field is not applicable to global health check services.
1257 # You must specify this field as part of the HTTP request URL. It is
1258 # not settable as a field in the request body.
1259 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1260 },
1261 ],
1262 &quot;kind&quot;: &quot;compute#healthCheckServicesList&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of
1263 # HealthCheckServices.
1264 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
1265 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1266 # the query parameter pageToken in the next list request.
1267 # Subsequent list requests will have their own nextPageToken to
1268 # continue paging through the results.
1269 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1270 &quot;warning&quot;: { # [Output Only] Informational warning message.
1271 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1272 # Engine returns NO_RESULTS_ON_PAGE if there
1273 # are no results in the response.
1274 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1275 # value format. For example:
1276 #
1277 # &quot;data&quot;: [
1278 # {
1279 # &quot;key&quot;: &quot;scope&quot;,
1280 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1281 # }
1282 {
1283 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1284 # returned. For example, for warnings where there are no results in a list
1285 # request for a particular zone, this key might be scope and
1286 # the key value might be the zone name. Other examples might be a key
1287 # indicating a deprecated resource and a suggested replacement, or a
1288 # warning about invalid network settings (for example, if an instance
1289 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1290 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1291 },
1292 ],
1293 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1294 },
1295 }</pre>
1296 </div>
1297
1298 <div class="method">
1299 <code class="details" id="list_next">list_next()</code>
1300 <pre>Retrieves the next page of results.
1301
1302 Args:
1303 previous_request: The request for the previous page. (required)
1304 previous_response: The response from the request for the previous page. (required)
1305
1306 Returns:
1307 A request object that you can call &#x27;execute()&#x27; on to request the next
1308 page. Returns None if there are no more items in the collection.
1309 </pre>
1310 </div>
1311
1312 <div class="method">
1313 <code class="details" id="patch">patch(project, region, healthCheckService, body=None, requestId=None, x__xgafv=None)</code>
1314 <pre>Updates the specified regional HealthCheckService resource
1315 with the data included in the request. This method supportsPATCH
1316 semantics and uses theJSON merge
1317 patch format and processing rules.
1318
1319 Args:
1320 project: string, Project ID for this request. (required)
1321 region: string, Name of the region scoping this request. (required)
1322 healthCheckService: string, Name of the HealthCheckService to update. The name
1323 must be 1-63 characters long, and comply with RFC1035. (required)
1324 body: object, The request body.
1325 The object takes the form of:
1326
1327 { # Represents a Health-Check as a Service resource.
1328 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1329 # text format.
1330 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1331 # create the resource.
1332 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1333 # This field is used in optimistic locking. This field will be ignored when
1334 # inserting a HealthCheckService. An up-to-date fingerprint must
1335 # be provided in order to patch/update the HealthCheckService; Otherwise, the
1336 # request will fail with error 412 conditionNotMet. To see the
1337 # latest fingerprint, make a get() request to retrieve the
1338 # HealthCheckService.
1339 &quot;healthChecks&quot;: [ # A list of URLs to the HealthCheck resources. Must have
1340 # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
1341 # regional HealthCheckService, theHealthCheck must be regional and in the same
1342 # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
1343 # global HealthChecks must specify sourceRegions,
1344 # and HealthChecks that specify sourceRegions can
1345 # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
1346 &quot;A String&quot;,
1347 ],
1348 &quot;healthStatusAggregationPolicy&quot;: &quot;A String&quot;, # Optional. Policy for how the results from multiple health checks
1349 # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
1350 # if unspecified.
1351 #
1352 # - NO_AGGREGATION. An EndpointHealth message is
1353 # returned for each pair in the health check
1354 # service.
1355 # - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
1356 #
1357 # .
1358 # This is only allowed with regional HealthCheckService.
1359 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1360 # defined by the server.
1361 &quot;kind&quot;: &quot;compute#healthCheckService&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
1362 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long, and comply
1363 # with RFC1035. Specifically, the name must be 1-63 characters
1364 # long and match the regular expression
1365 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
1366 # must be a lowercase letter, and all following characters must be a dash,
1367 # lowercase letter, or digit, except the last character, which cannot be a
1368 # dash.
1369 &quot;networkEndpointGroups&quot;: [ # A list of URLs to the NetworkEndpointGroup
1370 # resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in
1371 # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
1372 # must be global INTERNET_IP_PORT.
1373 &quot;A String&quot;,
1374 ],
1375 &quot;notificationEndpoints&quot;: [ # A list of URLs to the NotificationEndpoint
1376 # resources. Must not have more than 10. A list of endpoints for
1377 # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
1378 # same region. For global HealthCheckService,NotificationEndpoint must be global.
1379 &quot;A String&quot;,
1380 ],
1381 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the health check service
1382 # resides. This field is not applicable to global health check services.
1383 # You must specify this field as part of the HTTP request URL. It is
1384 # not settable as a field in the request body.
1385 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1386 }
1387
1388 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1389 that if you must retry your request, the server will know to ignore the
1390 request if it has already been completed.
1391
1392 For example, consider a situation where you make an initial request and
1393 the request times out. If you make the request again with the same
1394 request ID, the server can check if original operation with the same
1395 request ID was received, and if so, will ignore the second request. This
1396 prevents clients from accidentally creating duplicate commitments.
1397
1398 The request ID must be
1399 a valid UUID with the exception that zero UUID is not supported
1400 (00000000-0000-0000-0000-000000000000).
1401 x__xgafv: string, V1 error format.
1402 Allowed values
1403 1 - v1 error format
1404 2 - v2 error format
1405
1406 Returns:
1407 An object of the form:
1408
1409 { # Represents an Operation resource.
1410 #
1411 # Google Compute Engine has three Operation resources:
1412 #
1413 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1414 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1415 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1416 #
1417 # You can use an operation resource to manage asynchronous API requests.
1418 # For more information, readHandling
1419 # API responses.
1420 #
1421 # Operations can be global, regional or zonal.
1422 #
1423 # - For global operations, use the `globalOperations`
1424 # resource.
1425 # - For regional operations, use the
1426 # `regionOperations` resource.
1427 # - For zonal operations, use
1428 # the `zoneOperations` resource.
1429 #
1430 #
1431 #
1432 # For more information, read
1433 # Global, Regional, and Zonal Resources.
1434 #
1435 # Note that completed Operation resources have a limited
1436 # retention period.
1437 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1438 # Not present otherwise.
1439 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1440 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1441 # set when the operation is created.
1442 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1443 # text format.
1444 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1445 # this field will be populated.
1446 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1447 # operation.
1448 {
1449 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1450 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1451 # details. There is a set of defined message types to use for providing
1452 # details.The syntax depends on the error code. For example,
1453 # QuotaExceededInfo will have details when the error code is
1454 # QUOTA_EXCEEDED.
1455 {
1456 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1457 #
1458 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1459 # is not enabled:
1460 #
1461 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1462 # &quot;domain&quot;: &quot;googleapis.com&quot;
1463 # &quot;metadata&quot;: {
1464 # &quot;resource&quot;: &quot;projects/123&quot;,
1465 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1466 # }
1467 # }
1468 #
1469 # This response indicates that the pubsub.googleapis.com API is not enabled.
1470 #
1471 # Example of an error that is returned when attempting to create a Spanner
1472 # instance in a region that is out of stock:
1473 #
1474 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1475 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1476 # &quot;metadata&quot;: {
1477 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1478 # }
1479 # }
1480 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1481 # is typically the registered service name of the tool or product that
1482 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1483 # generated by some common infrastructure, the error domain must be a
1484 # globally unique value that identifies the infrastructure. For Google API
1485 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1486 &quot;metadatas&quot;: { # Additional structured details about this error.
1487 #
1488 # Keys must match a regular expression of `a-z+` but should
1489 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1490 # length. When identifying the current value of an exceeded limit, the units
1491 # should be contained in the key, not the value. For example, rather than
1492 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1493 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1494 # instances that can be created in a single (batch) request.
1495 &quot;a_key&quot;: &quot;A String&quot;,
1496 },
1497 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1498 # proximate cause of the error. Error reasons are unique within a particular
1499 # domain of errors. This should be at most 63 characters and match a
1500 # regular expression of `A-Z+[A-Z0-9]`, which represents
1501 # UPPER_SNAKE_CASE.
1502 },
1503 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1504 #
1505 # For example, if a quota check failed with an error indicating the calling
1506 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1507 # directly to the right place in the developer console to flip the bit.
1508 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1509 { # Describes a URL link.
1510 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1511 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1512 },
1513 ],
1514 },
1515 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1516 # which can be attached to an RPC error.
1517 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1518 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1519 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1520 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1521 },
1522 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1523 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1524 &quot;a_key&quot;: &quot;A String&quot;,
1525 },
1526 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1527 # type or metric.
1528 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1529 # or metric.
1530 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1531 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1532 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1533 },
1534 },
1535 ],
1536 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1537 # This property is optional.
1538 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1539 },
1540 ],
1541 },
1542 &quot;getVersionOperationMetadata&quot;: {
1543 &quot;inlineSbomInfo&quot;: {
1544 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1545 # appropriate identifiers.
1546 &quot;a_key&quot;: &quot;A String&quot;,
1547 },
1548 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1549 # identifiers.
1550 &quot;a_key&quot;: &quot;A String&quot;,
1551 },
1552 },
1553 },
1554 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1555 # message that was returned, such as `NOT FOUND`.
1556 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1557 # status code that was returned. For example, a `404` means the
1558 # resource was not found.
1559 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1560 # defined by the server.
1561 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1562 # This value is inRFC3339
1563 # text format.
1564 &quot;instancesBulkInsertOperationMetadata&quot;: {
1565 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1566 # Example key: zones/us-central1-a
1567 &quot;a_key&quot;: {
1568 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1569 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1570 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1571 # error.
1572 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1573 # if the flow is rolling forward or rolling back.
1574 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1575 },
1576 },
1577 },
1578 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1579 # Operation resources.
1580 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1581 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1582 # group of operations results from a `bulkInsert` API request.
1583 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1584 # `update`, or `delete`, and so on.
1585 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1586 # There is no requirement that this be linear or support any granularity of
1587 # operations. This should not be used to guess when the operation will be
1588 # complete. This number should monotonically increase as the operation
1589 # progresses.
1590 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1591 # applicable when performing regional operations.
1592 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1593 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1594 # this field will contain information on all underlying zonal actions and
1595 # their state.
1596 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1597 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1598 # Example key: zones/us-central1-a
1599 &quot;a_key&quot;: {
1600 &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
1601 # populated.
1602 # different programming environments, including REST APIs and RPC APIs. It is
1603 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1604 # three pieces of data: error code, error message, and error details.
1605 #
1606 # You can find out more about this error model and how to work with it in the
1607 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1608 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1609 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1610 # message types for APIs to use.
1611 {
1612 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1613 },
1614 ],
1615 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1616 # user-facing error message should be localized and sent in the
1617 # google.rpc.Status.details field, or localized by the client.
1618 },
1619 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1620 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1621 },
1622 },
1623 },
1624 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1625 # This value is inRFC3339
1626 # text format.
1627 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1628 # following:
1629 # `PENDING`, `RUNNING`, or `DONE`.
1630 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1631 # operation.
1632 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1633 # of the target resource.
1634 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1635 # operations related to creating a snapshot, this points to the disk
1636 # that the snapshot was created from.
1637 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1638 # `[email protected]` or
1639 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1640 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1641 # operation, this field will be populated.
1642 {
1643 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1644 # Engine returns NO_RESULTS_ON_PAGE if there
1645 # are no results in the response.
1646 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1647 # value format. For example:
1648 #
1649 # &quot;data&quot;: [
1650 # {
1651 # &quot;key&quot;: &quot;scope&quot;,
1652 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1653 # }
1654 {
1655 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1656 # returned. For example, for warnings where there are no results in a list
1657 # request for a particular zone, this key might be scope and
1658 # the key value might be the zone name. Other examples might be a key
1659 # indicating a deprecated resource and a suggested replacement, or a
1660 # warning about invalid network settings (for example, if an instance
1661 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1662 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1663 },
1664 ],
1665 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1666 },
1667 ],
1668 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1669 # applicable when performing per-zone operations.
1670 }</pre>
1671 </div>
1672
1673 <div class="method">
1674 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
1675 <pre>Returns permissions that a caller has on the specified resource.
1676
1677 Args:
1678 project: string, Project ID for this request. (required)
1679 region: string, The name of the region for this request. (required)
1680 resource: string, Name or id of the resource for this request. (required)
1681 body: object, The request body.
1682 The object takes the form of:
1683
1684 {
1685 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1686 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1687 &quot;A String&quot;,
1688 ],
1689 }
1690
1691 x__xgafv: string, V1 error format.
1692 Allowed values
1693 1 - v1 error format
1694 2 - v2 error format
1695
1696 Returns:
1697 An object of the form:
1698
1699 {
1700 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1701 # allowed.
1702 &quot;A String&quot;,
1703 ],
1704 }</pre>
1705 </div>
1706
1707 </body></html>