Debian Codegraph @

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