Debian Codegraph @

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