Debian Codegraph @

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