Debian Codegraph @

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