Debian Codegraph @

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