Debian Codegraph @

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