Debian Codegraph @

docs/dyn/compute_beta.regionHealthChecks.html

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