Debian Codegraph @

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