Debian Codegraph @

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