Debian Codegraph @

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