Debian Codegraph @

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