Debian Codegraph @

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