Debian Codegraph @

docs/dyn/compute_alpha.haControllers.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.haControllers.html">haControllers</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 an aggregated list of all of the HaControllers in the specified</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, haController, force=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes an HaController in the specified project.</p>
89 <p class="toc_element">
90 <code><a href="#failover">failover(project, region, haController, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Fails over a VM targeted by the specified HaController to the selected</p>
92 <p class="toc_element">
93 <code><a href="#get">get(project, region, haController, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns all the details of a specific HaController.</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">Creates HaController in the specified project.</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 all HaControllers in the specified project in the specified 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, haController, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Updates HaController in the specified project.</p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <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>
110 <pre>Retrieves an aggregated list of all of the HaControllers in the specified
111 project across all regions.
112
113 Args:
114 project: string, Project ID for this request. (required)
115 filter: string, A filter expression that filters resources listed in the response. Most
116 Compute resources support two types of filter expressions:
117 expressions that support regular expressions and expressions that follow
118 API improvement proposal AIP-160.
119 These two types of filter expressions cannot be mixed in one request.
120
121 If you want to use AIP-160, your expression must specify the field name, an
122 operator, and the value that you want to use for filtering. The value
123 must be a string, a number, or a boolean. The operator
124 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
125
126 For example, if you are filtering Compute Engine instances, you can
127 exclude instances named `example-instance` by specifying
128 `name != example-instance`.
129
130 The `:*` comparison can be used to test whether a key has been defined.
131 For example, to find all objects with `owner` label use:
132 ```
133 labels.owner:*
134 ```
135
136 You can also filter nested fields. For example, you could specify
137 `scheduling.automaticRestart = false` to include instances only
138 if they are not scheduled for automatic restarts. You can use filtering
139 on nested fields to filter based onresource labels.
140
141 To filter on multiple expressions, provide each separate expression within
142 parentheses. For example:
143 ```
144 (scheduling.automaticRestart = true)
145 (cpuPlatform = &quot;Intel Skylake&quot;)
146 ```
147 By default, each expression is an `AND` expression. However, you
148 can include `AND` and `OR` expressions explicitly.
149 For example:
150 ```
151 (cpuPlatform = &quot;Intel Skylake&quot;) OR
152 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
153 (scheduling.automaticRestart = true)
154 ```
155
156 If you want to use a regular expression, use the `eq` (equal) or `ne`
157 (not equal) operator against a single un-parenthesized expression with or
158 without quotes or against multiple parenthesized expressions. Examples:
159
160 `fieldname eq unquoted literal`
161 `fieldname eq &#x27;single quoted literal&#x27;`
162 `fieldname eq &quot;double quoted literal&quot;`
163 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
164
165 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
166 The literal value must match the entire field.
167
168 For example, to filter for instances that do not end with name &quot;instance&quot;,
169 you would use `name ne .*instance`.
170
171 You cannot combine constraints on multiple fields using regular
172 expressions.
173 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
174 global) should be included in the response. For new resource types added
175 after this field, the flag has no effect as new resource types will always
176 include every visible scope for each scope type in response. For resource
177 types which predate this field, if this flag is omitted or false, only
178 scopes of the scope types where the resource type is expected to be found
179 will be included.
180 maxResults: integer, The maximum number of results per page that should be returned.
181 If the number of available results is larger than `maxResults`,
182 Compute Engine returns a `nextPageToken` that can be used to get
183 the next page of results in subsequent list requests. Acceptable values are
184 `0` to `500`, inclusive. (Default: `500`)
185 orderBy: string, Sorts list results by a certain order. By default, results
186 are returned in alphanumerical order based on the resource name.
187
188 You can also sort results in descending order based on the creation
189 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
190 results based on the `creationTimestamp` field in
191 reverse chronological order (newest result first). Use this to sort
192 resources like operations so that the newest operation is returned first.
193
194 Currently, only sorting by `name` or
195 `creationTimestamp desc` is supported.
196 pageToken: string, Specifies a page token to use. Set `pageToken` to the
197 `nextPageToken` returned by a previous list request to get
198 the next page of results.
199 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
200 of failure. The default value is false.
201
202 For example, when partial success behavior is enabled, aggregatedList for a
203 single zone scope either returns all resources in the zone or no resources,
204 with an error code.
205 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
206 aggregated list request is invoked for subnetworks list-usable api.
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212 Returns:
213 An object of the form:
214
215 {
216 &quot;etag&quot;: &quot;A String&quot;,
217 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
218 &quot;items&quot;: { # A list of HaControllersScopedList resources.
219 &quot;a_key&quot;: { # Name of the scope containing this set of ha controllers.
220 &quot;haControllers&quot;: [ # List of HaControllers contained in this scope.
221 { # HaController handles failover for a VM Instance.
222 &quot;backendServices&quot;: [ # Advanced configuration option. If specified, these Backend Services need to
223 # be pre-created.
224 #
225 # Currently, only one backend service can be specified, and it must be L4
226 # Internal Load Balancer (ILB).
227 &quot;A String&quot;,
228 ],
229 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339
230 # text format.
231 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
232 # create the resource.
233 &quot;failoverCapacity&quot;: &quot;A String&quot;, # Capacity guarantee settings for the event of a failover.
234 # This determines whether capacity is guaranteed to be available
235 # in the zones used by the HaController.
236 # Deprecated: This field is deprecated and has no effect.
237 &quot;failoverInitiation&quot;: &quot;A String&quot;, # Indicates how failover should be initiated.
238 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
239 # defined by the server.
240 &quot;instanceName&quot;: &quot;A String&quot;, # Name of the instance that HaController is in charge of.
241 # If not specified the HaController&#x27;s resource name will be used instead.
242 # The name must be 1-63 characters long, and comply withRFC1035.
243 # Specifically, the name must be 1-63 characters long and match the regular
244 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
245 # must be a lowercase letter, and all following characters must be a dash,
246 # lowercase letter, or digit, except the last character, which cannot be a
247 # dash.
248 &quot;kind&quot;: &quot;compute#HaController&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#haController for HaControllers.
249 &quot;name&quot;: &quot;A String&quot;, # Name of the resource.
250 # Provided by the client when the resource is created.
251 # The name must be 1-63 characters long, and comply withRFC1035.
252 # Specifically, the name must be 1-63 characters long and match the regular
253 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
254 # must be a lowercase letter, and all following characters must be a dash,
255 # lowercase letter, or digit, except the last character, which cannot be a
256 # dash.
257 &quot;networkingAutoConfiguration&quot;: { # Basic networking configuration. Required backend services and forwarding # Basic networking configuration. Required backend services and forwarding
258 # rules will be automatically created with default parameters.
259 # rules will be automatically created with default parameters.
260 &quot;internal&quot;: { # Internal networking configuration # Internal networking configuration
261 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional. IP addresses will be automatically allocated according to
262 # StackType if not provided.
263 &quot;ipv6Address&quot;: &quot;A String&quot;,
264 &quot;stackType&quot;: &quot;A String&quot;, # Determine which IP addresses to automatically create. Field and option
265 # naming consistent with NetworkInterface configuration on Instances.
266 },
267 },
268 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the resource resides.
269 # You must specify this field as part of the HTTP request URL.
270 # It is not settable as a field in the request body.
271 &quot;secondaryZoneCapacity&quot;: &quot;A String&quot;, # Indicates the capacity guarantees in the secondary zone.
272 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for the resource.
273 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
274 &quot;status&quot;: { # Contains information about current status of the HaController. # Output only. [Output Only] Status information for the HaController resource.
275 &quot;failoverProgress&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the ongoing failover. This message
276 # is not displayed if failover is NOT in progress.
277 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
278 # Filled only if the failover is completed, in lastFailoverInfo.
279 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
280 # manually.
281 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
282 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
283 # is filled only if the current failover is failing
284 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
285 # failover.
286 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
287 # operation.
288 {
289 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
290 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
291 # details. There is a set of defined message types to use for providing
292 # details.The syntax depends on the error code. For example,
293 # QuotaExceededInfo will have details when the error code is
294 # QUOTA_EXCEEDED.
295 {
296 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
297 #
298 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
299 # is not enabled:
300 #
301 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
302 # &quot;domain&quot;: &quot;googleapis.com&quot;
303 # &quot;metadata&quot;: {
304 # &quot;resource&quot;: &quot;projects/123&quot;,
305 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
306 # }
307 # }
308 #
309 # This response indicates that the pubsub.googleapis.com API is not enabled.
310 #
311 # Example of an error that is returned when attempting to create a Spanner
312 # instance in a region that is out of stock:
313 #
314 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
315 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
316 # &quot;metadata&quot;: {
317 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
318 # }
319 # }
320 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
321 # is typically the registered service name of the tool or product that
322 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
323 # generated by some common infrastructure, the error domain must be a
324 # globally unique value that identifies the infrastructure. For Google API
325 # infrastructure, the error domain is &quot;googleapis.com&quot;.
326 &quot;metadatas&quot;: { # Additional structured details about this error.
327 #
328 # Keys must match a regular expression of `a-z+` but should
329 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
330 # length. When identifying the current value of an exceeded limit, the units
331 # should be contained in the key, not the value. For example, rather than
332 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
333 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
334 # instances that can be created in a single (batch) request.
335 &quot;a_key&quot;: &quot;A String&quot;,
336 },
337 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
338 # proximate cause of the error. Error reasons are unique within a particular
339 # domain of errors. This should be at most 63 characters and match a
340 # regular expression of `A-Z+[A-Z0-9]`, which represents
341 # UPPER_SNAKE_CASE.
342 },
343 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
344 #
345 # For example, if a quota check failed with an error indicating the calling
346 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
347 # directly to the right place in the developer console to flip the bit.
348 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
349 { # Describes a URL link.
350 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
351 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
352 },
353 ],
354 },
355 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
356 # which can be attached to an RPC error.
357 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
358 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
359 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
360 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
361 },
362 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
363 &quot;dimensions&quot;: { # The map holding related quota dimensions.
364 &quot;a_key&quot;: &quot;A String&quot;,
365 },
366 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
367 # type or metric.
368 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
369 # or metric.
370 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
371 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
372 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
373 },
374 },
375 ],
376 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
377 # This property is optional.
378 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
379 },
380 ],
381 },
382 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
383 # text format.
384 },
385 },
386 &quot;lastFailoverInfo&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the last successful failover.
387 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
388 # Filled only if the failover is completed, in lastFailoverInfo.
389 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
390 # manually.
391 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
392 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
393 # is filled only if the current failover is failing
394 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
395 # failover.
396 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
397 # operation.
398 {
399 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
400 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
401 # details. There is a set of defined message types to use for providing
402 # details.The syntax depends on the error code. For example,
403 # QuotaExceededInfo will have details when the error code is
404 # QUOTA_EXCEEDED.
405 {
406 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
407 #
408 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
409 # is not enabled:
410 #
411 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
412 # &quot;domain&quot;: &quot;googleapis.com&quot;
413 # &quot;metadata&quot;: {
414 # &quot;resource&quot;: &quot;projects/123&quot;,
415 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
416 # }
417 # }
418 #
419 # This response indicates that the pubsub.googleapis.com API is not enabled.
420 #
421 # Example of an error that is returned when attempting to create a Spanner
422 # instance in a region that is out of stock:
423 #
424 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
425 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
426 # &quot;metadata&quot;: {
427 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
428 # }
429 # }
430 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
431 # is typically the registered service name of the tool or product that
432 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
433 # generated by some common infrastructure, the error domain must be a
434 # globally unique value that identifies the infrastructure. For Google API
435 # infrastructure, the error domain is &quot;googleapis.com&quot;.
436 &quot;metadatas&quot;: { # Additional structured details about this error.
437 #
438 # Keys must match a regular expression of `a-z+` but should
439 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
440 # length. When identifying the current value of an exceeded limit, the units
441 # should be contained in the key, not the value. For example, rather than
442 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
443 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
444 # instances that can be created in a single (batch) request.
445 &quot;a_key&quot;: &quot;A String&quot;,
446 },
447 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
448 # proximate cause of the error. Error reasons are unique within a particular
449 # domain of errors. This should be at most 63 characters and match a
450 # regular expression of `A-Z+[A-Z0-9]`, which represents
451 # UPPER_SNAKE_CASE.
452 },
453 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
454 #
455 # For example, if a quota check failed with an error indicating the calling
456 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
457 # directly to the right place in the developer console to flip the bit.
458 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
459 { # Describes a URL link.
460 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
461 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
462 },
463 ],
464 },
465 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
466 # which can be attached to an RPC error.
467 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
468 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
469 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
470 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
471 },
472 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
473 &quot;dimensions&quot;: { # The map holding related quota dimensions.
474 &quot;a_key&quot;: &quot;A String&quot;,
475 },
476 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
477 # type or metric.
478 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
479 # or metric.
480 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
481 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
482 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
483 },
484 },
485 ],
486 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
487 # This property is optional.
488 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
489 },
490 ],
491 },
492 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
493 # text format.
494 },
495 },
496 &quot;ongoingFailover&quot;: True or False, # Output only. [Output Only] Indicates if the failover is currently in-progress.
497 &quot;primaryInstance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to the instance that is intended to be primary at
498 # this moment. Primary instance will be changed at the very beginning of a
499 # failover operation.
500 &quot;primaryZone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone that is intended to be primary at this
501 # moment. Primary zone will be changed at the very beginning of a failover
502 # operation. The zone may not be operational in the middle of a failover
503 # operation.
504 &quot;readyForFailover&quot;: True or False, # Output only. [Output Only] Indicates if the resource is ready for initiating a
505 # failover to the secondary zone.
506 &quot;zoneStatus&quot;: { # Output only. [Output Only] Map of zone statuses.
507 # Key: name of the zone
508 # Value: ZoneStatus
509 &quot;a_key&quot;: { # Contains the status of a specific zone.
510 &quot;isPrimary&quot;: True or False, # Output only. [Output Only] Indicates if the zone is primary at this moment.
511 &quot;isZoneReady&quot;: True or False, # Output only. [Output Only] Indicates if the zone is ready for initiating a failover.
512 &quot;lastError&quot;: { # Contains details of the last failed operation. # Output only. [Output Only] This field is filled only if the current operation is
513 # failing.
514 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors.
515 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
516 # operation.
517 {
518 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
519 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
520 # details. There is a set of defined message types to use for providing
521 # details.The syntax depends on the error code. For example,
522 # QuotaExceededInfo will have details when the error code is
523 # QUOTA_EXCEEDED.
524 {
525 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
526 #
527 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
528 # is not enabled:
529 #
530 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
531 # &quot;domain&quot;: &quot;googleapis.com&quot;
532 # &quot;metadata&quot;: {
533 # &quot;resource&quot;: &quot;projects/123&quot;,
534 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
535 # }
536 # }
537 #
538 # This response indicates that the pubsub.googleapis.com API is not enabled.
539 #
540 # Example of an error that is returned when attempting to create a Spanner
541 # instance in a region that is out of stock:
542 #
543 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
544 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
545 # &quot;metadata&quot;: {
546 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
547 # }
548 # }
549 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
550 # is typically the registered service name of the tool or product that
551 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
552 # generated by some common infrastructure, the error domain must be a
553 # globally unique value that identifies the infrastructure. For Google API
554 # infrastructure, the error domain is &quot;googleapis.com&quot;.
555 &quot;metadatas&quot;: { # Additional structured details about this error.
556 #
557 # Keys must match a regular expression of `a-z+` but should
558 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
559 # length. When identifying the current value of an exceeded limit, the units
560 # should be contained in the key, not the value. For example, rather than
561 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
562 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
563 # instances that can be created in a single (batch) request.
564 &quot;a_key&quot;: &quot;A String&quot;,
565 },
566 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
567 # proximate cause of the error. Error reasons are unique within a particular
568 # domain of errors. This should be at most 63 characters and match a
569 # regular expression of `A-Z+[A-Z0-9]`, which represents
570 # UPPER_SNAKE_CASE.
571 },
572 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
573 #
574 # For example, if a quota check failed with an error indicating the calling
575 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
576 # directly to the right place in the developer console to flip the bit.
577 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
578 { # Describes a URL link.
579 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
580 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
581 },
582 ],
583 },
584 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
585 # which can be attached to an RPC error.
586 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
587 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
588 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
589 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
590 },
591 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
592 &quot;dimensions&quot;: { # The map holding related quota dimensions.
593 &quot;a_key&quot;: &quot;A String&quot;,
594 },
595 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
596 # type or metric.
597 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
598 # or metric.
599 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
600 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
601 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
602 },
603 },
604 ],
605 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
606 # This property is optional.
607 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
608 },
609 ],
610 },
611 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
612 # text format.
613 },
614 },
615 },
616 },
617 &quot;zoneConfigurations&quot;: { # Map of zone configurations
618 # Key: name of the zone
619 # Value: ZoneConfiguration
620 &quot;a_key&quot;: { # Config for a zone that the HaController may use for running the VM
621 # instance.
622 &quot;nodeAffinities&quot;: [ # A set of node affinity configurations. Refer toConfiguring node
623 # affinity for more information.
624 # Overrides reservationAffinity.
625 { # Node Affinity: the configuration of desired nodes onto which the
626 # Instance could be scheduled.
627 # This message should be an exact copy of the Instances representation
628 # of NodeAffinity.
629 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
630 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
631 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
632 &quot;A String&quot;,
633 ],
634 },
635 ],
636 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that the instance can consume from.
637 # This message should be an exact copy of the Instances representation
638 # of AllocationAffinity.
639 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
640 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
641 # Consuming reserved instances for examples.
642 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
643 # the name of your reservation as its value.
644 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
645 # either a name to a reservation in the same project or
646 # &quot;projects/different-project/reservations/some-reservation-name&quot; to
647 # target a shared reservation in the same zone but in a different
648 # project.
649 &quot;A String&quot;,
650 ],
651 },
652 },
653 },
654 },
655 ],
656 &quot;warning&quot;: { # Informational warning which replaces the list of
657 # backend services when the list is empty.
658 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
659 # Engine returns NO_RESULTS_ON_PAGE if there
660 # are no results in the response.
661 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
662 # value format. For example:
663 #
664 # &quot;data&quot;: [
665 # {
666 # &quot;key&quot;: &quot;scope&quot;,
667 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
668 # }
669 {
670 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
671 # returned. For example, for warnings where there are no results in a list
672 # request for a particular zone, this key might be scope and
673 # the key value might be the zone name. Other examples might be a key
674 # indicating a deprecated resource and a suggested replacement, or a
675 # warning about invalid network settings (for example, if an instance
676 # attempts to perform IP forwarding but is not enabled for IP forwarding).
677 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
678 },
679 ],
680 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
681 },
682 },
683 },
684 &quot;kind&quot;: &quot;compute#haControllersAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#haControllersAggregatedList for lists of
685 # HaControllers.
686 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
687 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
688 # the query parameter pageToken in the next list request.
689 # Subsequent list requests will have their own nextPageToken to
690 # continue paging through the results.
691 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
692 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
693 &quot;A String&quot;,
694 ],
695 &quot;warning&quot;: { # [Output Only] Informational warning message.
696 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
697 # Engine returns NO_RESULTS_ON_PAGE if there
698 # are no results in the response.
699 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
700 # value format. For example:
701 #
702 # &quot;data&quot;: [
703 # {
704 # &quot;key&quot;: &quot;scope&quot;,
705 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
706 # }
707 {
708 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
709 # returned. For example, for warnings where there are no results in a list
710 # request for a particular zone, this key might be scope and
711 # the key value might be the zone name. Other examples might be a key
712 # indicating a deprecated resource and a suggested replacement, or a
713 # warning about invalid network settings (for example, if an instance
714 # attempts to perform IP forwarding but is not enabled for IP forwarding).
715 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
716 },
717 ],
718 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
719 },
720 }</pre>
721 </div>
722
723 <div class="method">
724 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
725 <pre>Retrieves the next page of results.
726
727 Args:
728 previous_request: The request for the previous page. (required)
729 previous_response: The response from the request for the previous page. (required)
730
731 Returns:
732 A request object that you can call &#x27;execute()&#x27; on to request the next
733 page. Returns None if there are no more items in the collection.
734 </pre>
735 </div>
736
737 <div class="method">
738 <code class="details" id="close">close()</code>
739 <pre>Close httplib2 connections.</pre>
740 </div>
741
742 <div class="method">
743 <code class="details" id="delete">delete(project, region, haController, force=None, requestId=None, x__xgafv=None)</code>
744 <pre>Deletes an HaController in the specified project.
745
746 Args:
747 project: string, Project ID for this request. (required)
748 region: string, Name of the region for this request. (required)
749 haController: string, Name of the HaController resource to delete. (required)
750 force: boolean, Force-deletes HA Controller when the Delete is stuck. Instance that is not
751 primary at the moment will also be deleted. Can only be used against the HA
752 Controller resource that is already being deleted.
753 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
754 that if you must retry your request, the server will know to ignore the
755 request if it has already been completed.
756 x__xgafv: string, V1 error format.
757 Allowed values
758 1 - v1 error format
759 2 - v2 error format
760
761 Returns:
762 An object of the form:
763
764 { # Represents an Operation resource.
765 #
766 # Google Compute Engine has three Operation resources:
767 #
768 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
769 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
770 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
771 #
772 # You can use an operation resource to manage asynchronous API requests.
773 # For more information, readHandling
774 # API responses.
775 #
776 # Operations can be global, regional or zonal.
777 #
778 # - For global operations, use the `globalOperations`
779 # resource.
780 # - For regional operations, use the
781 # `regionOperations` resource.
782 # - For zonal operations, use
783 # the `zoneOperations` resource.
784 #
785 #
786 #
787 # For more information, read
788 # Global, Regional, and Zonal Resources.
789 #
790 # Note that completed Operation resources have a limited
791 # retention period.
792 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
793 # Not present otherwise.
794 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
795 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
796 # set when the operation is created.
797 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
798 # text format.
799 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
800 # this field will be populated.
801 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
802 # operation.
803 {
804 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
805 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
806 # details. There is a set of defined message types to use for providing
807 # details.The syntax depends on the error code. For example,
808 # QuotaExceededInfo will have details when the error code is
809 # QUOTA_EXCEEDED.
810 {
811 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
812 #
813 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
814 # is not enabled:
815 #
816 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
817 # &quot;domain&quot;: &quot;googleapis.com&quot;
818 # &quot;metadata&quot;: {
819 # &quot;resource&quot;: &quot;projects/123&quot;,
820 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
821 # }
822 # }
823 #
824 # This response indicates that the pubsub.googleapis.com API is not enabled.
825 #
826 # Example of an error that is returned when attempting to create a Spanner
827 # instance in a region that is out of stock:
828 #
829 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
830 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
831 # &quot;metadata&quot;: {
832 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
833 # }
834 # }
835 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
836 # is typically the registered service name of the tool or product that
837 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
838 # generated by some common infrastructure, the error domain must be a
839 # globally unique value that identifies the infrastructure. For Google API
840 # infrastructure, the error domain is &quot;googleapis.com&quot;.
841 &quot;metadatas&quot;: { # Additional structured details about this error.
842 #
843 # Keys must match a regular expression of `a-z+` but should
844 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
845 # length. When identifying the current value of an exceeded limit, the units
846 # should be contained in the key, not the value. For example, rather than
847 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
848 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
849 # instances that can be created in a single (batch) request.
850 &quot;a_key&quot;: &quot;A String&quot;,
851 },
852 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
853 # proximate cause of the error. Error reasons are unique within a particular
854 # domain of errors. This should be at most 63 characters and match a
855 # regular expression of `A-Z+[A-Z0-9]`, which represents
856 # UPPER_SNAKE_CASE.
857 },
858 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
859 #
860 # For example, if a quota check failed with an error indicating the calling
861 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
862 # directly to the right place in the developer console to flip the bit.
863 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
864 { # Describes a URL link.
865 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
866 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
867 },
868 ],
869 },
870 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
871 # which can be attached to an RPC error.
872 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
873 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
874 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
875 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
876 },
877 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
878 &quot;dimensions&quot;: { # The map holding related quota dimensions.
879 &quot;a_key&quot;: &quot;A String&quot;,
880 },
881 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
882 # type or metric.
883 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
884 # or metric.
885 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
886 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
887 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
888 },
889 },
890 ],
891 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
892 # This property is optional.
893 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
894 },
895 ],
896 },
897 &quot;getVersionOperationMetadata&quot;: {
898 &quot;inlineSbomInfo&quot;: {
899 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
900 # appropriate identifiers.
901 &quot;a_key&quot;: &quot;A String&quot;,
902 },
903 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
904 # identifiers.
905 &quot;a_key&quot;: &quot;A String&quot;,
906 },
907 },
908 },
909 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
910 # message that was returned, such as `NOT FOUND`.
911 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
912 # status code that was returned. For example, a `404` means the
913 # resource was not found.
914 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
915 # defined by the server.
916 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
917 # This value is inRFC3339
918 # text format.
919 &quot;instancesBulkInsertOperationMetadata&quot;: {
920 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
921 # Example key: zones/us-central1-a
922 &quot;a_key&quot;: {
923 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
924 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
925 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
926 # error.
927 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
928 # if the flow is rolling forward or rolling back.
929 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
930 },
931 },
932 },
933 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
934 # Operation resources.
935 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
936 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
937 # group of operations results from a `bulkInsert` API request.
938 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
939 # `update`, or `delete`, and so on.
940 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
941 # There is no requirement that this be linear or support any granularity of
942 # operations. This should not be used to guess when the operation will be
943 # complete. This number should monotonically increase as the operation
944 # progresses.
945 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
946 # applicable when performing regional operations.
947 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
948 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
949 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
950 # this field will contain information on all underlying zonal actions and
951 # their state.
952 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
953 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
954 # Example key: zones/us-central1-a
955 &quot;a_key&quot;: {
956 &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
957 # populated.
958 # different programming environments, including REST APIs and RPC APIs. It is
959 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
960 # three pieces of data: error code, error message, and error details.
961 #
962 # You can find out more about this error model and how to work with it in the
963 # [API Design Guide](https://cloud.google.com/apis/design/errors).
964 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
965 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
966 # message types for APIs to use.
967 {
968 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
969 },
970 ],
971 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
972 # user-facing error message should be localized and sent in the
973 # google.rpc.Status.details field, or localized by the client.
974 },
975 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
976 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
977 },
978 },
979 },
980 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
981 # This value is inRFC3339
982 # text format.
983 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
984 # following:
985 # `PENDING`, `RUNNING`, or `DONE`.
986 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
987 # operation.
988 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
989 # of the target resource.
990 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
991 # operations related to creating a snapshot, this points to the disk
992 # that the snapshot was created from.
993 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
994 # `[email protected]` or
995 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
996 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
997 # operation, this field will be populated.
998 {
999 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1000 # Engine returns NO_RESULTS_ON_PAGE if there
1001 # are no results in the response.
1002 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1003 # value format. For example:
1004 #
1005 # &quot;data&quot;: [
1006 # {
1007 # &quot;key&quot;: &quot;scope&quot;,
1008 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1009 # }
1010 {
1011 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1012 # returned. For example, for warnings where there are no results in a list
1013 # request for a particular zone, this key might be scope and
1014 # the key value might be the zone name. Other examples might be a key
1015 # indicating a deprecated resource and a suggested replacement, or a
1016 # warning about invalid network settings (for example, if an instance
1017 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1018 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1019 },
1020 ],
1021 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1022 },
1023 ],
1024 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1025 # applicable when performing per-zone operations.
1026 }</pre>
1027 </div>
1028
1029 <div class="method">
1030 <code class="details" id="failover">failover(project, region, haController, body=None, requestId=None, x__xgafv=None)</code>
1031 <pre>Fails over a VM targeted by the specified HaController to the selected
1032 zone.
1033
1034 Args:
1035 project: string, Project ID for this request. (required)
1036 region: string, Name of the region for this request. (required)
1037 haController: string, ID of the HaController resource to update. (required)
1038 body: object, The request body.
1039 The object takes the form of:
1040
1041 {
1042 &quot;failoverToZone&quot;: &quot;A String&quot;, # Name of the destination zone for the failover.
1043 }
1044
1045 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1046 that if you must retry your request, the server will know to ignore the
1047 request if it has already been completed.
1048 x__xgafv: string, V1 error format.
1049 Allowed values
1050 1 - v1 error format
1051 2 - v2 error format
1052
1053 Returns:
1054 An object of the form:
1055
1056 { # Represents an Operation resource.
1057 #
1058 # Google Compute Engine has three Operation resources:
1059 #
1060 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1061 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1062 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1063 #
1064 # You can use an operation resource to manage asynchronous API requests.
1065 # For more information, readHandling
1066 # API responses.
1067 #
1068 # Operations can be global, regional or zonal.
1069 #
1070 # - For global operations, use the `globalOperations`
1071 # resource.
1072 # - For regional operations, use the
1073 # `regionOperations` resource.
1074 # - For zonal operations, use
1075 # the `zoneOperations` resource.
1076 #
1077 #
1078 #
1079 # For more information, read
1080 # Global, Regional, and Zonal Resources.
1081 #
1082 # Note that completed Operation resources have a limited
1083 # retention period.
1084 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1085 # Not present otherwise.
1086 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1087 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1088 # set when the operation is created.
1089 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1090 # text format.
1091 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1092 # this field will be populated.
1093 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1094 # operation.
1095 {
1096 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1097 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1098 # details. There is a set of defined message types to use for providing
1099 # details.The syntax depends on the error code. For example,
1100 # QuotaExceededInfo will have details when the error code is
1101 # QUOTA_EXCEEDED.
1102 {
1103 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1104 #
1105 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1106 # is not enabled:
1107 #
1108 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1109 # &quot;domain&quot;: &quot;googleapis.com&quot;
1110 # &quot;metadata&quot;: {
1111 # &quot;resource&quot;: &quot;projects/123&quot;,
1112 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1113 # }
1114 # }
1115 #
1116 # This response indicates that the pubsub.googleapis.com API is not enabled.
1117 #
1118 # Example of an error that is returned when attempting to create a Spanner
1119 # instance in a region that is out of stock:
1120 #
1121 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1122 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1123 # &quot;metadata&quot;: {
1124 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1125 # }
1126 # }
1127 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1128 # is typically the registered service name of the tool or product that
1129 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1130 # generated by some common infrastructure, the error domain must be a
1131 # globally unique value that identifies the infrastructure. For Google API
1132 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1133 &quot;metadatas&quot;: { # Additional structured details about this error.
1134 #
1135 # Keys must match a regular expression of `a-z+` but should
1136 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1137 # length. When identifying the current value of an exceeded limit, the units
1138 # should be contained in the key, not the value. For example, rather than
1139 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1140 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1141 # instances that can be created in a single (batch) request.
1142 &quot;a_key&quot;: &quot;A String&quot;,
1143 },
1144 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1145 # proximate cause of the error. Error reasons are unique within a particular
1146 # domain of errors. This should be at most 63 characters and match a
1147 # regular expression of `A-Z+[A-Z0-9]`, which represents
1148 # UPPER_SNAKE_CASE.
1149 },
1150 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1151 #
1152 # For example, if a quota check failed with an error indicating the calling
1153 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1154 # directly to the right place in the developer console to flip the bit.
1155 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1156 { # Describes a URL link.
1157 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1158 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1159 },
1160 ],
1161 },
1162 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1163 # which can be attached to an RPC error.
1164 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1165 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1166 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1167 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1168 },
1169 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1170 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1171 &quot;a_key&quot;: &quot;A String&quot;,
1172 },
1173 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1174 # type or metric.
1175 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1176 # or metric.
1177 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1178 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1179 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1180 },
1181 },
1182 ],
1183 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1184 # This property is optional.
1185 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1186 },
1187 ],
1188 },
1189 &quot;getVersionOperationMetadata&quot;: {
1190 &quot;inlineSbomInfo&quot;: {
1191 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1192 # appropriate identifiers.
1193 &quot;a_key&quot;: &quot;A String&quot;,
1194 },
1195 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1196 # identifiers.
1197 &quot;a_key&quot;: &quot;A String&quot;,
1198 },
1199 },
1200 },
1201 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1202 # message that was returned, such as `NOT FOUND`.
1203 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1204 # status code that was returned. For example, a `404` means the
1205 # resource was not found.
1206 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1207 # defined by the server.
1208 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1209 # This value is inRFC3339
1210 # text format.
1211 &quot;instancesBulkInsertOperationMetadata&quot;: {
1212 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1213 # Example key: zones/us-central1-a
1214 &quot;a_key&quot;: {
1215 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1216 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1217 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1218 # error.
1219 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1220 # if the flow is rolling forward or rolling back.
1221 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1222 },
1223 },
1224 },
1225 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1226 # Operation resources.
1227 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1228 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1229 # group of operations results from a `bulkInsert` API request.
1230 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1231 # `update`, or `delete`, and so on.
1232 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1233 # There is no requirement that this be linear or support any granularity of
1234 # operations. This should not be used to guess when the operation will be
1235 # complete. This number should monotonically increase as the operation
1236 # progresses.
1237 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1238 # applicable when performing regional operations.
1239 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1240 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1241 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1242 # this field will contain information on all underlying zonal actions and
1243 # their state.
1244 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1245 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1246 # Example key: zones/us-central1-a
1247 &quot;a_key&quot;: {
1248 &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
1249 # populated.
1250 # different programming environments, including REST APIs and RPC APIs. It is
1251 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1252 # three pieces of data: error code, error message, and error details.
1253 #
1254 # You can find out more about this error model and how to work with it in the
1255 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1256 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1257 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1258 # message types for APIs to use.
1259 {
1260 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1261 },
1262 ],
1263 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1264 # user-facing error message should be localized and sent in the
1265 # google.rpc.Status.details field, or localized by the client.
1266 },
1267 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1268 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1269 },
1270 },
1271 },
1272 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1273 # This value is inRFC3339
1274 # text format.
1275 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1276 # following:
1277 # `PENDING`, `RUNNING`, or `DONE`.
1278 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1279 # operation.
1280 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1281 # of the target resource.
1282 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1283 # operations related to creating a snapshot, this points to the disk
1284 # that the snapshot was created from.
1285 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1286 # `[email protected]` or
1287 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1288 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1289 # operation, this field will be populated.
1290 {
1291 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1292 # Engine returns NO_RESULTS_ON_PAGE if there
1293 # are no results in the response.
1294 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1295 # value format. For example:
1296 #
1297 # &quot;data&quot;: [
1298 # {
1299 # &quot;key&quot;: &quot;scope&quot;,
1300 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1301 # }
1302 {
1303 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1304 # returned. For example, for warnings where there are no results in a list
1305 # request for a particular zone, this key might be scope and
1306 # the key value might be the zone name. Other examples might be a key
1307 # indicating a deprecated resource and a suggested replacement, or a
1308 # warning about invalid network settings (for example, if an instance
1309 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1310 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1311 },
1312 ],
1313 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1314 },
1315 ],
1316 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1317 # applicable when performing per-zone operations.
1318 }</pre>
1319 </div>
1320
1321 <div class="method">
1322 <code class="details" id="get">get(project, region, haController, x__xgafv=None)</code>
1323 <pre>Returns all the details of a specific HaController.
1324
1325 Args:
1326 project: string, Project ID for this request. (required)
1327 region: string, Name of the region for this request. (required)
1328 haController: string, Name of the HaController resource to return. (required)
1329 x__xgafv: string, V1 error format.
1330 Allowed values
1331 1 - v1 error format
1332 2 - v2 error format
1333
1334 Returns:
1335 An object of the form:
1336
1337 { # HaController handles failover for a VM Instance.
1338 &quot;backendServices&quot;: [ # Advanced configuration option. If specified, these Backend Services need to
1339 # be pre-created.
1340 #
1341 # Currently, only one backend service can be specified, and it must be L4
1342 # Internal Load Balancer (ILB).
1343 &quot;A String&quot;,
1344 ],
1345 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339
1346 # text format.
1347 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1348 # create the resource.
1349 &quot;failoverCapacity&quot;: &quot;A String&quot;, # Capacity guarantee settings for the event of a failover.
1350 # This determines whether capacity is guaranteed to be available
1351 # in the zones used by the HaController.
1352 # Deprecated: This field is deprecated and has no effect.
1353 &quot;failoverInitiation&quot;: &quot;A String&quot;, # Indicates how failover should be initiated.
1354 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1355 # defined by the server.
1356 &quot;instanceName&quot;: &quot;A String&quot;, # Name of the instance that HaController is in charge of.
1357 # If not specified the HaController&#x27;s resource name will be used instead.
1358 # The name must be 1-63 characters long, and comply withRFC1035.
1359 # Specifically, the name must be 1-63 characters long and match the regular
1360 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
1361 # must be a lowercase letter, and all following characters must be a dash,
1362 # lowercase letter, or digit, except the last character, which cannot be a
1363 # dash.
1364 &quot;kind&quot;: &quot;compute#HaController&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#haController for HaControllers.
1365 &quot;name&quot;: &quot;A String&quot;, # Name of the resource.
1366 # Provided by the client when the resource is created.
1367 # The name must be 1-63 characters long, and comply withRFC1035.
1368 # Specifically, the name must be 1-63 characters long and match the regular
1369 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
1370 # must be a lowercase letter, and all following characters must be a dash,
1371 # lowercase letter, or digit, except the last character, which cannot be a
1372 # dash.
1373 &quot;networkingAutoConfiguration&quot;: { # Basic networking configuration. Required backend services and forwarding # Basic networking configuration. Required backend services and forwarding
1374 # rules will be automatically created with default parameters.
1375 # rules will be automatically created with default parameters.
1376 &quot;internal&quot;: { # Internal networking configuration # Internal networking configuration
1377 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional. IP addresses will be automatically allocated according to
1378 # StackType if not provided.
1379 &quot;ipv6Address&quot;: &quot;A String&quot;,
1380 &quot;stackType&quot;: &quot;A String&quot;, # Determine which IP addresses to automatically create. Field and option
1381 # naming consistent with NetworkInterface configuration on Instances.
1382 },
1383 },
1384 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the resource resides.
1385 # You must specify this field as part of the HTTP request URL.
1386 # It is not settable as a field in the request body.
1387 &quot;secondaryZoneCapacity&quot;: &quot;A String&quot;, # Indicates the capacity guarantees in the secondary zone.
1388 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for the resource.
1389 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1390 &quot;status&quot;: { # Contains information about current status of the HaController. # Output only. [Output Only] Status information for the HaController resource.
1391 &quot;failoverProgress&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the ongoing failover. This message
1392 # is not displayed if failover is NOT in progress.
1393 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
1394 # Filled only if the failover is completed, in lastFailoverInfo.
1395 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
1396 # manually.
1397 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
1398 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
1399 # is filled only if the current failover is failing
1400 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
1401 # failover.
1402 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1403 # operation.
1404 {
1405 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1406 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1407 # details. There is a set of defined message types to use for providing
1408 # details.The syntax depends on the error code. For example,
1409 # QuotaExceededInfo will have details when the error code is
1410 # QUOTA_EXCEEDED.
1411 {
1412 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1413 #
1414 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1415 # is not enabled:
1416 #
1417 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1418 # &quot;domain&quot;: &quot;googleapis.com&quot;
1419 # &quot;metadata&quot;: {
1420 # &quot;resource&quot;: &quot;projects/123&quot;,
1421 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1422 # }
1423 # }
1424 #
1425 # This response indicates that the pubsub.googleapis.com API is not enabled.
1426 #
1427 # Example of an error that is returned when attempting to create a Spanner
1428 # instance in a region that is out of stock:
1429 #
1430 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1431 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1432 # &quot;metadata&quot;: {
1433 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1434 # }
1435 # }
1436 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1437 # is typically the registered service name of the tool or product that
1438 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1439 # generated by some common infrastructure, the error domain must be a
1440 # globally unique value that identifies the infrastructure. For Google API
1441 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1442 &quot;metadatas&quot;: { # Additional structured details about this error.
1443 #
1444 # Keys must match a regular expression of `a-z+` but should
1445 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1446 # length. When identifying the current value of an exceeded limit, the units
1447 # should be contained in the key, not the value. For example, rather than
1448 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1449 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1450 # instances that can be created in a single (batch) request.
1451 &quot;a_key&quot;: &quot;A String&quot;,
1452 },
1453 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1454 # proximate cause of the error. Error reasons are unique within a particular
1455 # domain of errors. This should be at most 63 characters and match a
1456 # regular expression of `A-Z+[A-Z0-9]`, which represents
1457 # UPPER_SNAKE_CASE.
1458 },
1459 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1460 #
1461 # For example, if a quota check failed with an error indicating the calling
1462 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1463 # directly to the right place in the developer console to flip the bit.
1464 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1465 { # Describes a URL link.
1466 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1467 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1468 },
1469 ],
1470 },
1471 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1472 # which can be attached to an RPC error.
1473 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1474 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1475 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1476 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1477 },
1478 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1479 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1480 &quot;a_key&quot;: &quot;A String&quot;,
1481 },
1482 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1483 # type or metric.
1484 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1485 # or metric.
1486 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1487 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1488 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1489 },
1490 },
1491 ],
1492 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1493 # This property is optional.
1494 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1495 },
1496 ],
1497 },
1498 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
1499 # text format.
1500 },
1501 },
1502 &quot;lastFailoverInfo&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the last successful failover.
1503 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
1504 # Filled only if the failover is completed, in lastFailoverInfo.
1505 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
1506 # manually.
1507 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
1508 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
1509 # is filled only if the current failover is failing
1510 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
1511 # failover.
1512 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1513 # operation.
1514 {
1515 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1516 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1517 # details. There is a set of defined message types to use for providing
1518 # details.The syntax depends on the error code. For example,
1519 # QuotaExceededInfo will have details when the error code is
1520 # QUOTA_EXCEEDED.
1521 {
1522 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1523 #
1524 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1525 # is not enabled:
1526 #
1527 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1528 # &quot;domain&quot;: &quot;googleapis.com&quot;
1529 # &quot;metadata&quot;: {
1530 # &quot;resource&quot;: &quot;projects/123&quot;,
1531 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1532 # }
1533 # }
1534 #
1535 # This response indicates that the pubsub.googleapis.com API is not enabled.
1536 #
1537 # Example of an error that is returned when attempting to create a Spanner
1538 # instance in a region that is out of stock:
1539 #
1540 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1541 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1542 # &quot;metadata&quot;: {
1543 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1544 # }
1545 # }
1546 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1547 # is typically the registered service name of the tool or product that
1548 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1549 # generated by some common infrastructure, the error domain must be a
1550 # globally unique value that identifies the infrastructure. For Google API
1551 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1552 &quot;metadatas&quot;: { # Additional structured details about this error.
1553 #
1554 # Keys must match a regular expression of `a-z+` but should
1555 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1556 # length. When identifying the current value of an exceeded limit, the units
1557 # should be contained in the key, not the value. For example, rather than
1558 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1559 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1560 # instances that can be created in a single (batch) request.
1561 &quot;a_key&quot;: &quot;A String&quot;,
1562 },
1563 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1564 # proximate cause of the error. Error reasons are unique within a particular
1565 # domain of errors. This should be at most 63 characters and match a
1566 # regular expression of `A-Z+[A-Z0-9]`, which represents
1567 # UPPER_SNAKE_CASE.
1568 },
1569 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1570 #
1571 # For example, if a quota check failed with an error indicating the calling
1572 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1573 # directly to the right place in the developer console to flip the bit.
1574 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1575 { # Describes a URL link.
1576 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1577 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1578 },
1579 ],
1580 },
1581 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1582 # which can be attached to an RPC error.
1583 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1584 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1585 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1586 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1587 },
1588 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1589 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1590 &quot;a_key&quot;: &quot;A String&quot;,
1591 },
1592 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1593 # type or metric.
1594 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1595 # or metric.
1596 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1597 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1598 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1599 },
1600 },
1601 ],
1602 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1603 # This property is optional.
1604 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1605 },
1606 ],
1607 },
1608 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
1609 # text format.
1610 },
1611 },
1612 &quot;ongoingFailover&quot;: True or False, # Output only. [Output Only] Indicates if the failover is currently in-progress.
1613 &quot;primaryInstance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to the instance that is intended to be primary at
1614 # this moment. Primary instance will be changed at the very beginning of a
1615 # failover operation.
1616 &quot;primaryZone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone that is intended to be primary at this
1617 # moment. Primary zone will be changed at the very beginning of a failover
1618 # operation. The zone may not be operational in the middle of a failover
1619 # operation.
1620 &quot;readyForFailover&quot;: True or False, # Output only. [Output Only] Indicates if the resource is ready for initiating a
1621 # failover to the secondary zone.
1622 &quot;zoneStatus&quot;: { # Output only. [Output Only] Map of zone statuses.
1623 # Key: name of the zone
1624 # Value: ZoneStatus
1625 &quot;a_key&quot;: { # Contains the status of a specific zone.
1626 &quot;isPrimary&quot;: True or False, # Output only. [Output Only] Indicates if the zone is primary at this moment.
1627 &quot;isZoneReady&quot;: True or False, # Output only. [Output Only] Indicates if the zone is ready for initiating a failover.
1628 &quot;lastError&quot;: { # Contains details of the last failed operation. # Output only. [Output Only] This field is filled only if the current operation is
1629 # failing.
1630 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors.
1631 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1632 # operation.
1633 {
1634 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1635 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1636 # details. There is a set of defined message types to use for providing
1637 # details.The syntax depends on the error code. For example,
1638 # QuotaExceededInfo will have details when the error code is
1639 # QUOTA_EXCEEDED.
1640 {
1641 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1642 #
1643 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1644 # is not enabled:
1645 #
1646 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1647 # &quot;domain&quot;: &quot;googleapis.com&quot;
1648 # &quot;metadata&quot;: {
1649 # &quot;resource&quot;: &quot;projects/123&quot;,
1650 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1651 # }
1652 # }
1653 #
1654 # This response indicates that the pubsub.googleapis.com API is not enabled.
1655 #
1656 # Example of an error that is returned when attempting to create a Spanner
1657 # instance in a region that is out of stock:
1658 #
1659 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1660 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1661 # &quot;metadata&quot;: {
1662 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1663 # }
1664 # }
1665 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1666 # is typically the registered service name of the tool or product that
1667 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1668 # generated by some common infrastructure, the error domain must be a
1669 # globally unique value that identifies the infrastructure. For Google API
1670 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1671 &quot;metadatas&quot;: { # Additional structured details about this error.
1672 #
1673 # Keys must match a regular expression of `a-z+` but should
1674 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1675 # length. When identifying the current value of an exceeded limit, the units
1676 # should be contained in the key, not the value. For example, rather than
1677 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1678 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1679 # instances that can be created in a single (batch) request.
1680 &quot;a_key&quot;: &quot;A String&quot;,
1681 },
1682 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1683 # proximate cause of the error. Error reasons are unique within a particular
1684 # domain of errors. This should be at most 63 characters and match a
1685 # regular expression of `A-Z+[A-Z0-9]`, which represents
1686 # UPPER_SNAKE_CASE.
1687 },
1688 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1689 #
1690 # For example, if a quota check failed with an error indicating the calling
1691 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1692 # directly to the right place in the developer console to flip the bit.
1693 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1694 { # Describes a URL link.
1695 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1696 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1697 },
1698 ],
1699 },
1700 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1701 # which can be attached to an RPC error.
1702 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1703 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1704 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1705 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1706 },
1707 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1708 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1709 &quot;a_key&quot;: &quot;A String&quot;,
1710 },
1711 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1712 # type or metric.
1713 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1714 # or metric.
1715 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1716 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1717 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1718 },
1719 },
1720 ],
1721 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1722 # This property is optional.
1723 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1724 },
1725 ],
1726 },
1727 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
1728 # text format.
1729 },
1730 },
1731 },
1732 },
1733 &quot;zoneConfigurations&quot;: { # Map of zone configurations
1734 # Key: name of the zone
1735 # Value: ZoneConfiguration
1736 &quot;a_key&quot;: { # Config for a zone that the HaController may use for running the VM
1737 # instance.
1738 &quot;nodeAffinities&quot;: [ # A set of node affinity configurations. Refer toConfiguring node
1739 # affinity for more information.
1740 # Overrides reservationAffinity.
1741 { # Node Affinity: the configuration of desired nodes onto which the
1742 # Instance could be scheduled.
1743 # This message should be an exact copy of the Instances representation
1744 # of NodeAffinity.
1745 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
1746 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
1747 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
1748 &quot;A String&quot;,
1749 ],
1750 },
1751 ],
1752 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that the instance can consume from.
1753 # This message should be an exact copy of the Instances representation
1754 # of AllocationAffinity.
1755 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
1756 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
1757 # Consuming reserved instances for examples.
1758 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
1759 # the name of your reservation as its value.
1760 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
1761 # either a name to a reservation in the same project or
1762 # &quot;projects/different-project/reservations/some-reservation-name&quot; to
1763 # target a shared reservation in the same zone but in a different
1764 # project.
1765 &quot;A String&quot;,
1766 ],
1767 },
1768 },
1769 },
1770 }</pre>
1771 </div>
1772
1773 <div class="method">
1774 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
1775 <pre>Creates HaController in the specified project.
1776
1777 Args:
1778 project: string, Project ID for this request. (required)
1779 region: string, Name of the region for this request. (required)
1780 body: object, The request body.
1781 The object takes the form of:
1782
1783 { # HaController handles failover for a VM Instance.
1784 &quot;backendServices&quot;: [ # Advanced configuration option. If specified, these Backend Services need to
1785 # be pre-created.
1786 #
1787 # Currently, only one backend service can be specified, and it must be L4
1788 # Internal Load Balancer (ILB).
1789 &quot;A String&quot;,
1790 ],
1791 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339
1792 # text format.
1793 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1794 # create the resource.
1795 &quot;failoverCapacity&quot;: &quot;A String&quot;, # Capacity guarantee settings for the event of a failover.
1796 # This determines whether capacity is guaranteed to be available
1797 # in the zones used by the HaController.
1798 # Deprecated: This field is deprecated and has no effect.
1799 &quot;failoverInitiation&quot;: &quot;A String&quot;, # Indicates how failover should be initiated.
1800 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1801 # defined by the server.
1802 &quot;instanceName&quot;: &quot;A String&quot;, # Name of the instance that HaController is in charge of.
1803 # If not specified the HaController&#x27;s resource name will be used instead.
1804 # The name must be 1-63 characters long, and comply withRFC1035.
1805 # Specifically, the name must be 1-63 characters long and match the regular
1806 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
1807 # must be a lowercase letter, and all following characters must be a dash,
1808 # lowercase letter, or digit, except the last character, which cannot be a
1809 # dash.
1810 &quot;kind&quot;: &quot;compute#HaController&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#haController for HaControllers.
1811 &quot;name&quot;: &quot;A String&quot;, # Name of the resource.
1812 # Provided by the client when the resource is created.
1813 # The name must be 1-63 characters long, and comply withRFC1035.
1814 # Specifically, the name must be 1-63 characters long and match the regular
1815 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
1816 # must be a lowercase letter, and all following characters must be a dash,
1817 # lowercase letter, or digit, except the last character, which cannot be a
1818 # dash.
1819 &quot;networkingAutoConfiguration&quot;: { # Basic networking configuration. Required backend services and forwarding # Basic networking configuration. Required backend services and forwarding
1820 # rules will be automatically created with default parameters.
1821 # rules will be automatically created with default parameters.
1822 &quot;internal&quot;: { # Internal networking configuration # Internal networking configuration
1823 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional. IP addresses will be automatically allocated according to
1824 # StackType if not provided.
1825 &quot;ipv6Address&quot;: &quot;A String&quot;,
1826 &quot;stackType&quot;: &quot;A String&quot;, # Determine which IP addresses to automatically create. Field and option
1827 # naming consistent with NetworkInterface configuration on Instances.
1828 },
1829 },
1830 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the resource resides.
1831 # You must specify this field as part of the HTTP request URL.
1832 # It is not settable as a field in the request body.
1833 &quot;secondaryZoneCapacity&quot;: &quot;A String&quot;, # Indicates the capacity guarantees in the secondary zone.
1834 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for the resource.
1835 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1836 &quot;status&quot;: { # Contains information about current status of the HaController. # Output only. [Output Only] Status information for the HaController resource.
1837 &quot;failoverProgress&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the ongoing failover. This message
1838 # is not displayed if failover is NOT in progress.
1839 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
1840 # Filled only if the failover is completed, in lastFailoverInfo.
1841 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
1842 # manually.
1843 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
1844 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
1845 # is filled only if the current failover is failing
1846 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
1847 # failover.
1848 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1849 # operation.
1850 {
1851 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1852 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1853 # details. There is a set of defined message types to use for providing
1854 # details.The syntax depends on the error code. For example,
1855 # QuotaExceededInfo will have details when the error code is
1856 # QUOTA_EXCEEDED.
1857 {
1858 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1859 #
1860 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1861 # is not enabled:
1862 #
1863 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1864 # &quot;domain&quot;: &quot;googleapis.com&quot;
1865 # &quot;metadata&quot;: {
1866 # &quot;resource&quot;: &quot;projects/123&quot;,
1867 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1868 # }
1869 # }
1870 #
1871 # This response indicates that the pubsub.googleapis.com API is not enabled.
1872 #
1873 # Example of an error that is returned when attempting to create a Spanner
1874 # instance in a region that is out of stock:
1875 #
1876 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1877 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1878 # &quot;metadata&quot;: {
1879 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1880 # }
1881 # }
1882 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1883 # is typically the registered service name of the tool or product that
1884 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1885 # generated by some common infrastructure, the error domain must be a
1886 # globally unique value that identifies the infrastructure. For Google API
1887 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1888 &quot;metadatas&quot;: { # Additional structured details about this error.
1889 #
1890 # Keys must match a regular expression of `a-z+` but should
1891 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1892 # length. When identifying the current value of an exceeded limit, the units
1893 # should be contained in the key, not the value. For example, rather than
1894 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1895 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1896 # instances that can be created in a single (batch) request.
1897 &quot;a_key&quot;: &quot;A String&quot;,
1898 },
1899 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1900 # proximate cause of the error. Error reasons are unique within a particular
1901 # domain of errors. This should be at most 63 characters and match a
1902 # regular expression of `A-Z+[A-Z0-9]`, which represents
1903 # UPPER_SNAKE_CASE.
1904 },
1905 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1906 #
1907 # For example, if a quota check failed with an error indicating the calling
1908 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1909 # directly to the right place in the developer console to flip the bit.
1910 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1911 { # Describes a URL link.
1912 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1913 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1914 },
1915 ],
1916 },
1917 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1918 # which can be attached to an RPC error.
1919 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1920 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1921 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1922 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1923 },
1924 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1925 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1926 &quot;a_key&quot;: &quot;A String&quot;,
1927 },
1928 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1929 # type or metric.
1930 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1931 # or metric.
1932 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1933 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1934 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1935 },
1936 },
1937 ],
1938 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1939 # This property is optional.
1940 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1941 },
1942 ],
1943 },
1944 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
1945 # text format.
1946 },
1947 },
1948 &quot;lastFailoverInfo&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the last successful failover.
1949 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
1950 # Filled only if the failover is completed, in lastFailoverInfo.
1951 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
1952 # manually.
1953 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
1954 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
1955 # is filled only if the current failover is failing
1956 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
1957 # failover.
1958 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1959 # operation.
1960 {
1961 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1962 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1963 # details. There is a set of defined message types to use for providing
1964 # details.The syntax depends on the error code. For example,
1965 # QuotaExceededInfo will have details when the error code is
1966 # QUOTA_EXCEEDED.
1967 {
1968 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1969 #
1970 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1971 # is not enabled:
1972 #
1973 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1974 # &quot;domain&quot;: &quot;googleapis.com&quot;
1975 # &quot;metadata&quot;: {
1976 # &quot;resource&quot;: &quot;projects/123&quot;,
1977 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1978 # }
1979 # }
1980 #
1981 # This response indicates that the pubsub.googleapis.com API is not enabled.
1982 #
1983 # Example of an error that is returned when attempting to create a Spanner
1984 # instance in a region that is out of stock:
1985 #
1986 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1987 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1988 # &quot;metadata&quot;: {
1989 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1990 # }
1991 # }
1992 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1993 # is typically the registered service name of the tool or product that
1994 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1995 # generated by some common infrastructure, the error domain must be a
1996 # globally unique value that identifies the infrastructure. For Google API
1997 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1998 &quot;metadatas&quot;: { # Additional structured details about this error.
1999 #
2000 # Keys must match a regular expression of `a-z+` but should
2001 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2002 # length. When identifying the current value of an exceeded limit, the units
2003 # should be contained in the key, not the value. For example, rather than
2004 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2005 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2006 # instances that can be created in a single (batch) request.
2007 &quot;a_key&quot;: &quot;A String&quot;,
2008 },
2009 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2010 # proximate cause of the error. Error reasons are unique within a particular
2011 # domain of errors. This should be at most 63 characters and match a
2012 # regular expression of `A-Z+[A-Z0-9]`, which represents
2013 # UPPER_SNAKE_CASE.
2014 },
2015 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2016 #
2017 # For example, if a quota check failed with an error indicating the calling
2018 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2019 # directly to the right place in the developer console to flip the bit.
2020 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2021 { # Describes a URL link.
2022 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2023 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2024 },
2025 ],
2026 },
2027 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2028 # which can be attached to an RPC error.
2029 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2030 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2031 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2032 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2033 },
2034 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2035 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2036 &quot;a_key&quot;: &quot;A String&quot;,
2037 },
2038 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2039 # type or metric.
2040 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2041 # or metric.
2042 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2043 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2044 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2045 },
2046 },
2047 ],
2048 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2049 # This property is optional.
2050 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2051 },
2052 ],
2053 },
2054 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
2055 # text format.
2056 },
2057 },
2058 &quot;ongoingFailover&quot;: True or False, # Output only. [Output Only] Indicates if the failover is currently in-progress.
2059 &quot;primaryInstance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to the instance that is intended to be primary at
2060 # this moment. Primary instance will be changed at the very beginning of a
2061 # failover operation.
2062 &quot;primaryZone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone that is intended to be primary at this
2063 # moment. Primary zone will be changed at the very beginning of a failover
2064 # operation. The zone may not be operational in the middle of a failover
2065 # operation.
2066 &quot;readyForFailover&quot;: True or False, # Output only. [Output Only] Indicates if the resource is ready for initiating a
2067 # failover to the secondary zone.
2068 &quot;zoneStatus&quot;: { # Output only. [Output Only] Map of zone statuses.
2069 # Key: name of the zone
2070 # Value: ZoneStatus
2071 &quot;a_key&quot;: { # Contains the status of a specific zone.
2072 &quot;isPrimary&quot;: True or False, # Output only. [Output Only] Indicates if the zone is primary at this moment.
2073 &quot;isZoneReady&quot;: True or False, # Output only. [Output Only] Indicates if the zone is ready for initiating a failover.
2074 &quot;lastError&quot;: { # Contains details of the last failed operation. # Output only. [Output Only] This field is filled only if the current operation is
2075 # failing.
2076 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors.
2077 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2078 # operation.
2079 {
2080 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2081 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2082 # details. There is a set of defined message types to use for providing
2083 # details.The syntax depends on the error code. For example,
2084 # QuotaExceededInfo will have details when the error code is
2085 # QUOTA_EXCEEDED.
2086 {
2087 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2088 #
2089 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2090 # is not enabled:
2091 #
2092 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2093 # &quot;domain&quot;: &quot;googleapis.com&quot;
2094 # &quot;metadata&quot;: {
2095 # &quot;resource&quot;: &quot;projects/123&quot;,
2096 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2097 # }
2098 # }
2099 #
2100 # This response indicates that the pubsub.googleapis.com API is not enabled.
2101 #
2102 # Example of an error that is returned when attempting to create a Spanner
2103 # instance in a region that is out of stock:
2104 #
2105 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2106 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2107 # &quot;metadata&quot;: {
2108 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2109 # }
2110 # }
2111 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2112 # is typically the registered service name of the tool or product that
2113 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2114 # generated by some common infrastructure, the error domain must be a
2115 # globally unique value that identifies the infrastructure. For Google API
2116 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2117 &quot;metadatas&quot;: { # Additional structured details about this error.
2118 #
2119 # Keys must match a regular expression of `a-z+` but should
2120 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2121 # length. When identifying the current value of an exceeded limit, the units
2122 # should be contained in the key, not the value. For example, rather than
2123 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2124 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2125 # instances that can be created in a single (batch) request.
2126 &quot;a_key&quot;: &quot;A String&quot;,
2127 },
2128 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2129 # proximate cause of the error. Error reasons are unique within a particular
2130 # domain of errors. This should be at most 63 characters and match a
2131 # regular expression of `A-Z+[A-Z0-9]`, which represents
2132 # UPPER_SNAKE_CASE.
2133 },
2134 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2135 #
2136 # For example, if a quota check failed with an error indicating the calling
2137 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2138 # directly to the right place in the developer console to flip the bit.
2139 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2140 { # Describes a URL link.
2141 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2142 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2143 },
2144 ],
2145 },
2146 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2147 # which can be attached to an RPC error.
2148 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2149 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2150 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2151 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2152 },
2153 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2154 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2155 &quot;a_key&quot;: &quot;A String&quot;,
2156 },
2157 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2158 # type or metric.
2159 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2160 # or metric.
2161 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2162 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2163 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2164 },
2165 },
2166 ],
2167 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2168 # This property is optional.
2169 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2170 },
2171 ],
2172 },
2173 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
2174 # text format.
2175 },
2176 },
2177 },
2178 },
2179 &quot;zoneConfigurations&quot;: { # Map of zone configurations
2180 # Key: name of the zone
2181 # Value: ZoneConfiguration
2182 &quot;a_key&quot;: { # Config for a zone that the HaController may use for running the VM
2183 # instance.
2184 &quot;nodeAffinities&quot;: [ # A set of node affinity configurations. Refer toConfiguring node
2185 # affinity for more information.
2186 # Overrides reservationAffinity.
2187 { # Node Affinity: the configuration of desired nodes onto which the
2188 # Instance could be scheduled.
2189 # This message should be an exact copy of the Instances representation
2190 # of NodeAffinity.
2191 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
2192 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
2193 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
2194 &quot;A String&quot;,
2195 ],
2196 },
2197 ],
2198 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that the instance can consume from.
2199 # This message should be an exact copy of the Instances representation
2200 # of AllocationAffinity.
2201 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
2202 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
2203 # Consuming reserved instances for examples.
2204 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
2205 # the name of your reservation as its value.
2206 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
2207 # either a name to a reservation in the same project or
2208 # &quot;projects/different-project/reservations/some-reservation-name&quot; to
2209 # target a shared reservation in the same zone but in a different
2210 # project.
2211 &quot;A String&quot;,
2212 ],
2213 },
2214 },
2215 },
2216 }
2217
2218 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2219 that if you must retry your request, the server will know to ignore the
2220 request if it has already been completed.
2221 x__xgafv: string, V1 error format.
2222 Allowed values
2223 1 - v1 error format
2224 2 - v2 error format
2225
2226 Returns:
2227 An object of the form:
2228
2229 { # Represents an Operation resource.
2230 #
2231 # Google Compute Engine has three Operation resources:
2232 #
2233 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2234 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2235 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2236 #
2237 # You can use an operation resource to manage asynchronous API requests.
2238 # For more information, readHandling
2239 # API responses.
2240 #
2241 # Operations can be global, regional or zonal.
2242 #
2243 # - For global operations, use the `globalOperations`
2244 # resource.
2245 # - For regional operations, use the
2246 # `regionOperations` resource.
2247 # - For zonal operations, use
2248 # the `zoneOperations` resource.
2249 #
2250 #
2251 #
2252 # For more information, read
2253 # Global, Regional, and Zonal Resources.
2254 #
2255 # Note that completed Operation resources have a limited
2256 # retention period.
2257 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2258 # Not present otherwise.
2259 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2260 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2261 # set when the operation is created.
2262 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2263 # text format.
2264 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2265 # this field will be populated.
2266 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2267 # operation.
2268 {
2269 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2270 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2271 # details. There is a set of defined message types to use for providing
2272 # details.The syntax depends on the error code. For example,
2273 # QuotaExceededInfo will have details when the error code is
2274 # QUOTA_EXCEEDED.
2275 {
2276 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2277 #
2278 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2279 # is not enabled:
2280 #
2281 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2282 # &quot;domain&quot;: &quot;googleapis.com&quot;
2283 # &quot;metadata&quot;: {
2284 # &quot;resource&quot;: &quot;projects/123&quot;,
2285 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2286 # }
2287 # }
2288 #
2289 # This response indicates that the pubsub.googleapis.com API is not enabled.
2290 #
2291 # Example of an error that is returned when attempting to create a Spanner
2292 # instance in a region that is out of stock:
2293 #
2294 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2295 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2296 # &quot;metadata&quot;: {
2297 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2298 # }
2299 # }
2300 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2301 # is typically the registered service name of the tool or product that
2302 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2303 # generated by some common infrastructure, the error domain must be a
2304 # globally unique value that identifies the infrastructure. For Google API
2305 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2306 &quot;metadatas&quot;: { # Additional structured details about this error.
2307 #
2308 # Keys must match a regular expression of `a-z+` but should
2309 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2310 # length. When identifying the current value of an exceeded limit, the units
2311 # should be contained in the key, not the value. For example, rather than
2312 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2313 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2314 # instances that can be created in a single (batch) request.
2315 &quot;a_key&quot;: &quot;A String&quot;,
2316 },
2317 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2318 # proximate cause of the error. Error reasons are unique within a particular
2319 # domain of errors. This should be at most 63 characters and match a
2320 # regular expression of `A-Z+[A-Z0-9]`, which represents
2321 # UPPER_SNAKE_CASE.
2322 },
2323 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2324 #
2325 # For example, if a quota check failed with an error indicating the calling
2326 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2327 # directly to the right place in the developer console to flip the bit.
2328 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2329 { # Describes a URL link.
2330 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2331 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2332 },
2333 ],
2334 },
2335 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2336 # which can be attached to an RPC error.
2337 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2338 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2339 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2340 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2341 },
2342 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2343 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2344 &quot;a_key&quot;: &quot;A String&quot;,
2345 },
2346 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2347 # type or metric.
2348 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2349 # or metric.
2350 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2351 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2352 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2353 },
2354 },
2355 ],
2356 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2357 # This property is optional.
2358 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2359 },
2360 ],
2361 },
2362 &quot;getVersionOperationMetadata&quot;: {
2363 &quot;inlineSbomInfo&quot;: {
2364 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2365 # appropriate identifiers.
2366 &quot;a_key&quot;: &quot;A String&quot;,
2367 },
2368 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2369 # identifiers.
2370 &quot;a_key&quot;: &quot;A String&quot;,
2371 },
2372 },
2373 },
2374 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2375 # message that was returned, such as `NOT FOUND`.
2376 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2377 # status code that was returned. For example, a `404` means the
2378 # resource was not found.
2379 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2380 # defined by the server.
2381 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2382 # This value is inRFC3339
2383 # text format.
2384 &quot;instancesBulkInsertOperationMetadata&quot;: {
2385 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2386 # Example key: zones/us-central1-a
2387 &quot;a_key&quot;: {
2388 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2389 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2390 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2391 # error.
2392 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2393 # if the flow is rolling forward or rolling back.
2394 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2395 },
2396 },
2397 },
2398 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2399 # Operation resources.
2400 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2401 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2402 # group of operations results from a `bulkInsert` API request.
2403 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2404 # `update`, or `delete`, and so on.
2405 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2406 # There is no requirement that this be linear or support any granularity of
2407 # operations. This should not be used to guess when the operation will be
2408 # complete. This number should monotonically increase as the operation
2409 # progresses.
2410 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2411 # applicable when performing regional operations.
2412 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2413 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2414 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2415 # this field will contain information on all underlying zonal actions and
2416 # their state.
2417 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2418 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2419 # Example key: zones/us-central1-a
2420 &quot;a_key&quot;: {
2421 &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
2422 # populated.
2423 # different programming environments, including REST APIs and RPC APIs. It is
2424 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2425 # three pieces of data: error code, error message, and error details.
2426 #
2427 # You can find out more about this error model and how to work with it in the
2428 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2429 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2430 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2431 # message types for APIs to use.
2432 {
2433 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2434 },
2435 ],
2436 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2437 # user-facing error message should be localized and sent in the
2438 # google.rpc.Status.details field, or localized by the client.
2439 },
2440 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2441 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2442 },
2443 },
2444 },
2445 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2446 # This value is inRFC3339
2447 # text format.
2448 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2449 # following:
2450 # `PENDING`, `RUNNING`, or `DONE`.
2451 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2452 # operation.
2453 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2454 # of the target resource.
2455 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2456 # operations related to creating a snapshot, this points to the disk
2457 # that the snapshot was created from.
2458 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2459 # `[email protected]` or
2460 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2461 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2462 # operation, this field will be populated.
2463 {
2464 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2465 # Engine returns NO_RESULTS_ON_PAGE if there
2466 # are no results in the response.
2467 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2468 # value format. For example:
2469 #
2470 # &quot;data&quot;: [
2471 # {
2472 # &quot;key&quot;: &quot;scope&quot;,
2473 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2474 # }
2475 {
2476 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2477 # returned. For example, for warnings where there are no results in a list
2478 # request for a particular zone, this key might be scope and
2479 # the key value might be the zone name. Other examples might be a key
2480 # indicating a deprecated resource and a suggested replacement, or a
2481 # warning about invalid network settings (for example, if an instance
2482 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2483 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2484 },
2485 ],
2486 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2487 },
2488 ],
2489 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2490 # applicable when performing per-zone operations.
2491 }</pre>
2492 </div>
2493
2494 <div class="method">
2495 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2496 <pre>Lists all HaControllers in the specified project in the specified region.
2497
2498 Args:
2499 project: string, Project ID for this request. (required)
2500 region: string, Name of the region for this request. (required)
2501 filter: string, A filter expression that filters resources listed in the response. Most
2502 Compute resources support two types of filter expressions:
2503 expressions that support regular expressions and expressions that follow
2504 API improvement proposal AIP-160.
2505 These two types of filter expressions cannot be mixed in one request.
2506
2507 If you want to use AIP-160, your expression must specify the field name, an
2508 operator, and the value that you want to use for filtering. The value
2509 must be a string, a number, or a boolean. The operator
2510 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2511
2512 For example, if you are filtering Compute Engine instances, you can
2513 exclude instances named `example-instance` by specifying
2514 `name != example-instance`.
2515
2516 The `:*` comparison can be used to test whether a key has been defined.
2517 For example, to find all objects with `owner` label use:
2518 ```
2519 labels.owner:*
2520 ```
2521
2522 You can also filter nested fields. For example, you could specify
2523 `scheduling.automaticRestart = false` to include instances only
2524 if they are not scheduled for automatic restarts. You can use filtering
2525 on nested fields to filter based onresource labels.
2526
2527 To filter on multiple expressions, provide each separate expression within
2528 parentheses. For example:
2529 ```
2530 (scheduling.automaticRestart = true)
2531 (cpuPlatform = &quot;Intel Skylake&quot;)
2532 ```
2533 By default, each expression is an `AND` expression. However, you
2534 can include `AND` and `OR` expressions explicitly.
2535 For example:
2536 ```
2537 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2538 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2539 (scheduling.automaticRestart = true)
2540 ```
2541
2542 If you want to use a regular expression, use the `eq` (equal) or `ne`
2543 (not equal) operator against a single un-parenthesized expression with or
2544 without quotes or against multiple parenthesized expressions. Examples:
2545
2546 `fieldname eq unquoted literal`
2547 `fieldname eq &#x27;single quoted literal&#x27;`
2548 `fieldname eq &quot;double quoted literal&quot;`
2549 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2550
2551 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2552 The literal value must match the entire field.
2553
2554 For example, to filter for instances that do not end with name &quot;instance&quot;,
2555 you would use `name ne .*instance`.
2556
2557 You cannot combine constraints on multiple fields using regular
2558 expressions.
2559 maxResults: integer, The maximum number of results per page that should be returned.
2560 If the number of available results is larger than `maxResults`,
2561 Compute Engine returns a `nextPageToken` that can be used to get
2562 the next page of results in subsequent list requests. Acceptable values are
2563 `0` to `500`, inclusive. (Default: `500`)
2564 orderBy: string, Sorts list results by a certain order. By default, results
2565 are returned in alphanumerical order based on the resource name.
2566
2567 You can also sort results in descending order based on the creation
2568 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2569 results based on the `creationTimestamp` field in
2570 reverse chronological order (newest result first). Use this to sort
2571 resources like operations so that the newest operation is returned first.
2572
2573 Currently, only sorting by `name` or
2574 `creationTimestamp desc` is supported.
2575 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2576 `nextPageToken` returned by a previous list request to get
2577 the next page of results.
2578 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2579 of failure. The default value is false.
2580
2581 For example, when partial success behavior is enabled, aggregatedList for a
2582 single zone scope either returns all resources in the zone or no resources,
2583 with an error code.
2584 x__xgafv: string, V1 error format.
2585 Allowed values
2586 1 - v1 error format
2587 2 - v2 error format
2588
2589 Returns:
2590 An object of the form:
2591
2592 {
2593 &quot;etag&quot;: &quot;A String&quot;,
2594 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server.
2595 &quot;items&quot;: [ # A list of HaControllers in the specified project and region.
2596 { # HaController handles failover for a VM Instance.
2597 &quot;backendServices&quot;: [ # Advanced configuration option. If specified, these Backend Services need to
2598 # be pre-created.
2599 #
2600 # Currently, only one backend service can be specified, and it must be L4
2601 # Internal Load Balancer (ILB).
2602 &quot;A String&quot;,
2603 ],
2604 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339
2605 # text format.
2606 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2607 # create the resource.
2608 &quot;failoverCapacity&quot;: &quot;A String&quot;, # Capacity guarantee settings for the event of a failover.
2609 # This determines whether capacity is guaranteed to be available
2610 # in the zones used by the HaController.
2611 # Deprecated: This field is deprecated and has no effect.
2612 &quot;failoverInitiation&quot;: &quot;A String&quot;, # Indicates how failover should be initiated.
2613 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2614 # defined by the server.
2615 &quot;instanceName&quot;: &quot;A String&quot;, # Name of the instance that HaController is in charge of.
2616 # If not specified the HaController&#x27;s resource name will be used instead.
2617 # The name must be 1-63 characters long, and comply withRFC1035.
2618 # Specifically, the name must be 1-63 characters long and match the regular
2619 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
2620 # must be a lowercase letter, and all following characters must be a dash,
2621 # lowercase letter, or digit, except the last character, which cannot be a
2622 # dash.
2623 &quot;kind&quot;: &quot;compute#HaController&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#haController for HaControllers.
2624 &quot;name&quot;: &quot;A String&quot;, # Name of the resource.
2625 # Provided by the client when the resource is created.
2626 # The name must be 1-63 characters long, and comply withRFC1035.
2627 # Specifically, the name must be 1-63 characters long and match the regular
2628 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
2629 # must be a lowercase letter, and all following characters must be a dash,
2630 # lowercase letter, or digit, except the last character, which cannot be a
2631 # dash.
2632 &quot;networkingAutoConfiguration&quot;: { # Basic networking configuration. Required backend services and forwarding # Basic networking configuration. Required backend services and forwarding
2633 # rules will be automatically created with default parameters.
2634 # rules will be automatically created with default parameters.
2635 &quot;internal&quot;: { # Internal networking configuration # Internal networking configuration
2636 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional. IP addresses will be automatically allocated according to
2637 # StackType if not provided.
2638 &quot;ipv6Address&quot;: &quot;A String&quot;,
2639 &quot;stackType&quot;: &quot;A String&quot;, # Determine which IP addresses to automatically create. Field and option
2640 # naming consistent with NetworkInterface configuration on Instances.
2641 },
2642 },
2643 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the resource resides.
2644 # You must specify this field as part of the HTTP request URL.
2645 # It is not settable as a field in the request body.
2646 &quot;secondaryZoneCapacity&quot;: &quot;A String&quot;, # Indicates the capacity guarantees in the secondary zone.
2647 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for the resource.
2648 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2649 &quot;status&quot;: { # Contains information about current status of the HaController. # Output only. [Output Only] Status information for the HaController resource.
2650 &quot;failoverProgress&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the ongoing failover. This message
2651 # is not displayed if failover is NOT in progress.
2652 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
2653 # Filled only if the failover is completed, in lastFailoverInfo.
2654 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
2655 # manually.
2656 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
2657 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
2658 # is filled only if the current failover is failing
2659 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
2660 # failover.
2661 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2662 # operation.
2663 {
2664 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2665 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2666 # details. There is a set of defined message types to use for providing
2667 # details.The syntax depends on the error code. For example,
2668 # QuotaExceededInfo will have details when the error code is
2669 # QUOTA_EXCEEDED.
2670 {
2671 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2672 #
2673 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2674 # is not enabled:
2675 #
2676 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2677 # &quot;domain&quot;: &quot;googleapis.com&quot;
2678 # &quot;metadata&quot;: {
2679 # &quot;resource&quot;: &quot;projects/123&quot;,
2680 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2681 # }
2682 # }
2683 #
2684 # This response indicates that the pubsub.googleapis.com API is not enabled.
2685 #
2686 # Example of an error that is returned when attempting to create a Spanner
2687 # instance in a region that is out of stock:
2688 #
2689 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2690 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2691 # &quot;metadata&quot;: {
2692 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2693 # }
2694 # }
2695 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2696 # is typically the registered service name of the tool or product that
2697 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2698 # generated by some common infrastructure, the error domain must be a
2699 # globally unique value that identifies the infrastructure. For Google API
2700 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2701 &quot;metadatas&quot;: { # Additional structured details about this error.
2702 #
2703 # Keys must match a regular expression of `a-z+` but should
2704 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2705 # length. When identifying the current value of an exceeded limit, the units
2706 # should be contained in the key, not the value. For example, rather than
2707 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2708 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2709 # instances that can be created in a single (batch) request.
2710 &quot;a_key&quot;: &quot;A String&quot;,
2711 },
2712 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2713 # proximate cause of the error. Error reasons are unique within a particular
2714 # domain of errors. This should be at most 63 characters and match a
2715 # regular expression of `A-Z+[A-Z0-9]`, which represents
2716 # UPPER_SNAKE_CASE.
2717 },
2718 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2719 #
2720 # For example, if a quota check failed with an error indicating the calling
2721 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2722 # directly to the right place in the developer console to flip the bit.
2723 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2724 { # Describes a URL link.
2725 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2726 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2727 },
2728 ],
2729 },
2730 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2731 # which can be attached to an RPC error.
2732 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2733 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2734 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2735 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2736 },
2737 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2738 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2739 &quot;a_key&quot;: &quot;A String&quot;,
2740 },
2741 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2742 # type or metric.
2743 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2744 # or metric.
2745 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2746 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2747 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2748 },
2749 },
2750 ],
2751 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2752 # This property is optional.
2753 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2754 },
2755 ],
2756 },
2757 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
2758 # text format.
2759 },
2760 },
2761 &quot;lastFailoverInfo&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the last successful failover.
2762 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
2763 # Filled only if the failover is completed, in lastFailoverInfo.
2764 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
2765 # manually.
2766 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
2767 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
2768 # is filled only if the current failover is failing
2769 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
2770 # failover.
2771 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2772 # operation.
2773 {
2774 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2775 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2776 # details. There is a set of defined message types to use for providing
2777 # details.The syntax depends on the error code. For example,
2778 # QuotaExceededInfo will have details when the error code is
2779 # QUOTA_EXCEEDED.
2780 {
2781 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2782 #
2783 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2784 # is not enabled:
2785 #
2786 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2787 # &quot;domain&quot;: &quot;googleapis.com&quot;
2788 # &quot;metadata&quot;: {
2789 # &quot;resource&quot;: &quot;projects/123&quot;,
2790 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2791 # }
2792 # }
2793 #
2794 # This response indicates that the pubsub.googleapis.com API is not enabled.
2795 #
2796 # Example of an error that is returned when attempting to create a Spanner
2797 # instance in a region that is out of stock:
2798 #
2799 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2800 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2801 # &quot;metadata&quot;: {
2802 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2803 # }
2804 # }
2805 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2806 # is typically the registered service name of the tool or product that
2807 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2808 # generated by some common infrastructure, the error domain must be a
2809 # globally unique value that identifies the infrastructure. For Google API
2810 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2811 &quot;metadatas&quot;: { # Additional structured details about this error.
2812 #
2813 # Keys must match a regular expression of `a-z+` but should
2814 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2815 # length. When identifying the current value of an exceeded limit, the units
2816 # should be contained in the key, not the value. For example, rather than
2817 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2818 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2819 # instances that can be created in a single (batch) request.
2820 &quot;a_key&quot;: &quot;A String&quot;,
2821 },
2822 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2823 # proximate cause of the error. Error reasons are unique within a particular
2824 # domain of errors. This should be at most 63 characters and match a
2825 # regular expression of `A-Z+[A-Z0-9]`, which represents
2826 # UPPER_SNAKE_CASE.
2827 },
2828 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2829 #
2830 # For example, if a quota check failed with an error indicating the calling
2831 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2832 # directly to the right place in the developer console to flip the bit.
2833 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2834 { # Describes a URL link.
2835 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2836 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2837 },
2838 ],
2839 },
2840 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2841 # which can be attached to an RPC error.
2842 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2843 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2844 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2845 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2846 },
2847 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2848 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2849 &quot;a_key&quot;: &quot;A String&quot;,
2850 },
2851 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2852 # type or metric.
2853 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2854 # or metric.
2855 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2856 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2857 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2858 },
2859 },
2860 ],
2861 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2862 # This property is optional.
2863 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2864 },
2865 ],
2866 },
2867 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
2868 # text format.
2869 },
2870 },
2871 &quot;ongoingFailover&quot;: True or False, # Output only. [Output Only] Indicates if the failover is currently in-progress.
2872 &quot;primaryInstance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to the instance that is intended to be primary at
2873 # this moment. Primary instance will be changed at the very beginning of a
2874 # failover operation.
2875 &quot;primaryZone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone that is intended to be primary at this
2876 # moment. Primary zone will be changed at the very beginning of a failover
2877 # operation. The zone may not be operational in the middle of a failover
2878 # operation.
2879 &quot;readyForFailover&quot;: True or False, # Output only. [Output Only] Indicates if the resource is ready for initiating a
2880 # failover to the secondary zone.
2881 &quot;zoneStatus&quot;: { # Output only. [Output Only] Map of zone statuses.
2882 # Key: name of the zone
2883 # Value: ZoneStatus
2884 &quot;a_key&quot;: { # Contains the status of a specific zone.
2885 &quot;isPrimary&quot;: True or False, # Output only. [Output Only] Indicates if the zone is primary at this moment.
2886 &quot;isZoneReady&quot;: True or False, # Output only. [Output Only] Indicates if the zone is ready for initiating a failover.
2887 &quot;lastError&quot;: { # Contains details of the last failed operation. # Output only. [Output Only] This field is filled only if the current operation is
2888 # failing.
2889 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors.
2890 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2891 # operation.
2892 {
2893 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2894 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2895 # details. There is a set of defined message types to use for providing
2896 # details.The syntax depends on the error code. For example,
2897 # QuotaExceededInfo will have details when the error code is
2898 # QUOTA_EXCEEDED.
2899 {
2900 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2901 #
2902 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2903 # is not enabled:
2904 #
2905 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2906 # &quot;domain&quot;: &quot;googleapis.com&quot;
2907 # &quot;metadata&quot;: {
2908 # &quot;resource&quot;: &quot;projects/123&quot;,
2909 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2910 # }
2911 # }
2912 #
2913 # This response indicates that the pubsub.googleapis.com API is not enabled.
2914 #
2915 # Example of an error that is returned when attempting to create a Spanner
2916 # instance in a region that is out of stock:
2917 #
2918 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2919 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2920 # &quot;metadata&quot;: {
2921 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2922 # }
2923 # }
2924 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2925 # is typically the registered service name of the tool or product that
2926 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2927 # generated by some common infrastructure, the error domain must be a
2928 # globally unique value that identifies the infrastructure. For Google API
2929 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2930 &quot;metadatas&quot;: { # Additional structured details about this error.
2931 #
2932 # Keys must match a regular expression of `a-z+` but should
2933 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2934 # length. When identifying the current value of an exceeded limit, the units
2935 # should be contained in the key, not the value. For example, rather than
2936 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2937 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2938 # instances that can be created in a single (batch) request.
2939 &quot;a_key&quot;: &quot;A String&quot;,
2940 },
2941 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2942 # proximate cause of the error. Error reasons are unique within a particular
2943 # domain of errors. This should be at most 63 characters and match a
2944 # regular expression of `A-Z+[A-Z0-9]`, which represents
2945 # UPPER_SNAKE_CASE.
2946 },
2947 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2948 #
2949 # For example, if a quota check failed with an error indicating the calling
2950 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2951 # directly to the right place in the developer console to flip the bit.
2952 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2953 { # Describes a URL link.
2954 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2955 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2956 },
2957 ],
2958 },
2959 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2960 # which can be attached to an RPC error.
2961 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2962 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2963 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2964 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2965 },
2966 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2967 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2968 &quot;a_key&quot;: &quot;A String&quot;,
2969 },
2970 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2971 # type or metric.
2972 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2973 # or metric.
2974 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2975 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2976 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2977 },
2978 },
2979 ],
2980 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2981 # This property is optional.
2982 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2983 },
2984 ],
2985 },
2986 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
2987 # text format.
2988 },
2989 },
2990 },
2991 },
2992 &quot;zoneConfigurations&quot;: { # Map of zone configurations
2993 # Key: name of the zone
2994 # Value: ZoneConfiguration
2995 &quot;a_key&quot;: { # Config for a zone that the HaController may use for running the VM
2996 # instance.
2997 &quot;nodeAffinities&quot;: [ # A set of node affinity configurations. Refer toConfiguring node
2998 # affinity for more information.
2999 # Overrides reservationAffinity.
3000 { # Node Affinity: the configuration of desired nodes onto which the
3001 # Instance could be scheduled.
3002 # This message should be an exact copy of the Instances representation
3003 # of NodeAffinity.
3004 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
3005 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
3006 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
3007 &quot;A String&quot;,
3008 ],
3009 },
3010 ],
3011 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that the instance can consume from.
3012 # This message should be an exact copy of the Instances representation
3013 # of AllocationAffinity.
3014 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
3015 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
3016 # Consuming reserved instances for examples.
3017 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
3018 # the name of your reservation as its value.
3019 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
3020 # either a name to a reservation in the same project or
3021 # &quot;projects/different-project/reservations/some-reservation-name&quot; to
3022 # target a shared reservation in the same zone but in a different
3023 # project.
3024 &quot;A String&quot;,
3025 ],
3026 },
3027 },
3028 },
3029 },
3030 ],
3031 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for
3032 # the query parameter pageToken in the next list request.
3033 # Subsequent list requests will have their own nextPageToken to
3034 # continue paging through the results.
3035 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for this resource.
3036 &quot;unreachables&quot;: [ # Output only. [Output only] Unreachable resources.
3037 &quot;A String&quot;,
3038 ],
3039 &quot;warning&quot;: { # Informational warning message.
3040 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3041 # Engine returns NO_RESULTS_ON_PAGE if there
3042 # are no results in the response.
3043 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3044 # value format. For example:
3045 #
3046 # &quot;data&quot;: [
3047 # {
3048 # &quot;key&quot;: &quot;scope&quot;,
3049 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3050 # }
3051 {
3052 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3053 # returned. For example, for warnings where there are no results in a list
3054 # request for a particular zone, this key might be scope and
3055 # the key value might be the zone name. Other examples might be a key
3056 # indicating a deprecated resource and a suggested replacement, or a
3057 # warning about invalid network settings (for example, if an instance
3058 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3059 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3060 },
3061 ],
3062 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3063 },
3064 }</pre>
3065 </div>
3066
3067 <div class="method">
3068 <code class="details" id="list_next">list_next()</code>
3069 <pre>Retrieves the next page of results.
3070
3071 Args:
3072 previous_request: The request for the previous page. (required)
3073 previous_response: The response from the request for the previous page. (required)
3074
3075 Returns:
3076 A request object that you can call &#x27;execute()&#x27; on to request the next
3077 page. Returns None if there are no more items in the collection.
3078 </pre>
3079 </div>
3080
3081 <div class="method">
3082 <code class="details" id="patch">patch(project, region, haController, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
3083 <pre>Updates HaController in the specified project.
3084
3085 Args:
3086 project: string, Project ID for this request. (required)
3087 region: string, Name of the region for this request. (required)
3088 haController: string, ID of the HaController resource to update. (required)
3089 body: object, The request body.
3090 The object takes the form of:
3091
3092 { # HaController handles failover for a VM Instance.
3093 &quot;backendServices&quot;: [ # Advanced configuration option. If specified, these Backend Services need to
3094 # be pre-created.
3095 #
3096 # Currently, only one backend service can be specified, and it must be L4
3097 # Internal Load Balancer (ILB).
3098 &quot;A String&quot;,
3099 ],
3100 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339
3101 # text format.
3102 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3103 # create the resource.
3104 &quot;failoverCapacity&quot;: &quot;A String&quot;, # Capacity guarantee settings for the event of a failover.
3105 # This determines whether capacity is guaranteed to be available
3106 # in the zones used by the HaController.
3107 # Deprecated: This field is deprecated and has no effect.
3108 &quot;failoverInitiation&quot;: &quot;A String&quot;, # Indicates how failover should be initiated.
3109 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3110 # defined by the server.
3111 &quot;instanceName&quot;: &quot;A String&quot;, # Name of the instance that HaController is in charge of.
3112 # If not specified the HaController&#x27;s resource name will be used instead.
3113 # The name must be 1-63 characters long, and comply withRFC1035.
3114 # Specifically, the name must be 1-63 characters long and match the regular
3115 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
3116 # must be a lowercase letter, and all following characters must be a dash,
3117 # lowercase letter, or digit, except the last character, which cannot be a
3118 # dash.
3119 &quot;kind&quot;: &quot;compute#HaController&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#haController for HaControllers.
3120 &quot;name&quot;: &quot;A String&quot;, # Name of the resource.
3121 # Provided by the client when the resource is created.
3122 # The name must be 1-63 characters long, and comply withRFC1035.
3123 # Specifically, the name must be 1-63 characters long and match the regular
3124 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
3125 # must be a lowercase letter, and all following characters must be a dash,
3126 # lowercase letter, or digit, except the last character, which cannot be a
3127 # dash.
3128 &quot;networkingAutoConfiguration&quot;: { # Basic networking configuration. Required backend services and forwarding # Basic networking configuration. Required backend services and forwarding
3129 # rules will be automatically created with default parameters.
3130 # rules will be automatically created with default parameters.
3131 &quot;internal&quot;: { # Internal networking configuration # Internal networking configuration
3132 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional. IP addresses will be automatically allocated according to
3133 # StackType if not provided.
3134 &quot;ipv6Address&quot;: &quot;A String&quot;,
3135 &quot;stackType&quot;: &quot;A String&quot;, # Determine which IP addresses to automatically create. Field and option
3136 # naming consistent with NetworkInterface configuration on Instances.
3137 },
3138 },
3139 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the resource resides.
3140 # You must specify this field as part of the HTTP request URL.
3141 # It is not settable as a field in the request body.
3142 &quot;secondaryZoneCapacity&quot;: &quot;A String&quot;, # Indicates the capacity guarantees in the secondary zone.
3143 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for the resource.
3144 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3145 &quot;status&quot;: { # Contains information about current status of the HaController. # Output only. [Output Only] Status information for the HaController resource.
3146 &quot;failoverProgress&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the ongoing failover. This message
3147 # is not displayed if failover is NOT in progress.
3148 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
3149 # Filled only if the failover is completed, in lastFailoverInfo.
3150 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
3151 # manually.
3152 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
3153 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
3154 # is filled only if the current failover is failing
3155 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
3156 # failover.
3157 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3158 # operation.
3159 {
3160 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3161 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3162 # details. There is a set of defined message types to use for providing
3163 # details.The syntax depends on the error code. For example,
3164 # QuotaExceededInfo will have details when the error code is
3165 # QUOTA_EXCEEDED.
3166 {
3167 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3168 #
3169 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3170 # is not enabled:
3171 #
3172 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3173 # &quot;domain&quot;: &quot;googleapis.com&quot;
3174 # &quot;metadata&quot;: {
3175 # &quot;resource&quot;: &quot;projects/123&quot;,
3176 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3177 # }
3178 # }
3179 #
3180 # This response indicates that the pubsub.googleapis.com API is not enabled.
3181 #
3182 # Example of an error that is returned when attempting to create a Spanner
3183 # instance in a region that is out of stock:
3184 #
3185 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3186 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3187 # &quot;metadata&quot;: {
3188 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3189 # }
3190 # }
3191 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3192 # is typically the registered service name of the tool or product that
3193 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3194 # generated by some common infrastructure, the error domain must be a
3195 # globally unique value that identifies the infrastructure. For Google API
3196 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3197 &quot;metadatas&quot;: { # Additional structured details about this error.
3198 #
3199 # Keys must match a regular expression of `a-z+` but should
3200 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3201 # length. When identifying the current value of an exceeded limit, the units
3202 # should be contained in the key, not the value. For example, rather than
3203 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3204 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3205 # instances that can be created in a single (batch) request.
3206 &quot;a_key&quot;: &quot;A String&quot;,
3207 },
3208 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3209 # proximate cause of the error. Error reasons are unique within a particular
3210 # domain of errors. This should be at most 63 characters and match a
3211 # regular expression of `A-Z+[A-Z0-9]`, which represents
3212 # UPPER_SNAKE_CASE.
3213 },
3214 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3215 #
3216 # For example, if a quota check failed with an error indicating the calling
3217 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3218 # directly to the right place in the developer console to flip the bit.
3219 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3220 { # Describes a URL link.
3221 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3222 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3223 },
3224 ],
3225 },
3226 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3227 # which can be attached to an RPC error.
3228 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3229 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3230 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3231 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3232 },
3233 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3234 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3235 &quot;a_key&quot;: &quot;A String&quot;,
3236 },
3237 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3238 # type or metric.
3239 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3240 # or metric.
3241 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3242 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3243 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3244 },
3245 },
3246 ],
3247 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3248 # This property is optional.
3249 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3250 },
3251 ],
3252 },
3253 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
3254 # text format.
3255 },
3256 },
3257 &quot;lastFailoverInfo&quot;: { # Contains information about the current failover operation. # Output only. [Output Only] Contains the details of the last successful failover.
3258 &quot;failoverCompleteTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the failover completion.
3259 # Filled only if the failover is completed, in lastFailoverInfo.
3260 &quot;failoverTrigger&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates if failover has been triggered automatically or
3261 # manually.
3262 &quot;failoverTriggerTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Timestamp of the last failover trigger.
3263 &quot;lastFailoverAttempt&quot;: { # Output only. [Output Only] Contains details of the last failed failover. This field
3264 # is filled only if the current failover is failing
3265 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to process
3266 # failover.
3267 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3268 # operation.
3269 {
3270 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3271 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3272 # details. There is a set of defined message types to use for providing
3273 # details.The syntax depends on the error code. For example,
3274 # QuotaExceededInfo will have details when the error code is
3275 # QUOTA_EXCEEDED.
3276 {
3277 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3278 #
3279 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3280 # is not enabled:
3281 #
3282 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3283 # &quot;domain&quot;: &quot;googleapis.com&quot;
3284 # &quot;metadata&quot;: {
3285 # &quot;resource&quot;: &quot;projects/123&quot;,
3286 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3287 # }
3288 # }
3289 #
3290 # This response indicates that the pubsub.googleapis.com API is not enabled.
3291 #
3292 # Example of an error that is returned when attempting to create a Spanner
3293 # instance in a region that is out of stock:
3294 #
3295 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3296 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3297 # &quot;metadata&quot;: {
3298 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3299 # }
3300 # }
3301 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3302 # is typically the registered service name of the tool or product that
3303 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3304 # generated by some common infrastructure, the error domain must be a
3305 # globally unique value that identifies the infrastructure. For Google API
3306 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3307 &quot;metadatas&quot;: { # Additional structured details about this error.
3308 #
3309 # Keys must match a regular expression of `a-z+` but should
3310 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3311 # length. When identifying the current value of an exceeded limit, the units
3312 # should be contained in the key, not the value. For example, rather than
3313 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3314 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3315 # instances that can be created in a single (batch) request.
3316 &quot;a_key&quot;: &quot;A String&quot;,
3317 },
3318 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3319 # proximate cause of the error. Error reasons are unique within a particular
3320 # domain of errors. This should be at most 63 characters and match a
3321 # regular expression of `A-Z+[A-Z0-9]`, which represents
3322 # UPPER_SNAKE_CASE.
3323 },
3324 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3325 #
3326 # For example, if a quota check failed with an error indicating the calling
3327 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3328 # directly to the right place in the developer console to flip the bit.
3329 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3330 { # Describes a URL link.
3331 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3332 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3333 },
3334 ],
3335 },
3336 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3337 # which can be attached to an RPC error.
3338 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3339 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3340 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3341 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3342 },
3343 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3344 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3345 &quot;a_key&quot;: &quot;A String&quot;,
3346 },
3347 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3348 # type or metric.
3349 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3350 # or metric.
3351 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3352 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3353 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3354 },
3355 },
3356 ],
3357 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3358 # This property is optional.
3359 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3360 },
3361 ],
3362 },
3363 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
3364 # text format.
3365 },
3366 },
3367 &quot;ongoingFailover&quot;: True or False, # Output only. [Output Only] Indicates if the failover is currently in-progress.
3368 &quot;primaryInstance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL to the instance that is intended to be primary at
3369 # this moment. Primary instance will be changed at the very beginning of a
3370 # failover operation.
3371 &quot;primaryZone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone that is intended to be primary at this
3372 # moment. Primary zone will be changed at the very beginning of a failover
3373 # operation. The zone may not be operational in the middle of a failover
3374 # operation.
3375 &quot;readyForFailover&quot;: True or False, # Output only. [Output Only] Indicates if the resource is ready for initiating a
3376 # failover to the secondary zone.
3377 &quot;zoneStatus&quot;: { # Output only. [Output Only] Map of zone statuses.
3378 # Key: name of the zone
3379 # Value: ZoneStatus
3380 &quot;a_key&quot;: { # Contains the status of a specific zone.
3381 &quot;isPrimary&quot;: True or False, # Output only. [Output Only] Indicates if the zone is primary at this moment.
3382 &quot;isZoneReady&quot;: True or False, # Output only. [Output Only] Indicates if the zone is ready for initiating a failover.
3383 &quot;lastError&quot;: { # Contains details of the last failed operation. # Output only. [Output Only] This field is filled only if the current operation is
3384 # failing.
3385 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors.
3386 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3387 # operation.
3388 {
3389 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3390 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3391 # details. There is a set of defined message types to use for providing
3392 # details.The syntax depends on the error code. For example,
3393 # QuotaExceededInfo will have details when the error code is
3394 # QUOTA_EXCEEDED.
3395 {
3396 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3397 #
3398 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3399 # is not enabled:
3400 #
3401 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3402 # &quot;domain&quot;: &quot;googleapis.com&quot;
3403 # &quot;metadata&quot;: {
3404 # &quot;resource&quot;: &quot;projects/123&quot;,
3405 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3406 # }
3407 # }
3408 #
3409 # This response indicates that the pubsub.googleapis.com API is not enabled.
3410 #
3411 # Example of an error that is returned when attempting to create a Spanner
3412 # instance in a region that is out of stock:
3413 #
3414 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3415 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3416 # &quot;metadata&quot;: {
3417 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3418 # }
3419 # }
3420 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3421 # is typically the registered service name of the tool or product that
3422 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3423 # generated by some common infrastructure, the error domain must be a
3424 # globally unique value that identifies the infrastructure. For Google API
3425 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3426 &quot;metadatas&quot;: { # Additional structured details about this error.
3427 #
3428 # Keys must match a regular expression of `a-z+` but should
3429 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3430 # length. When identifying the current value of an exceeded limit, the units
3431 # should be contained in the key, not the value. For example, rather than
3432 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3433 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3434 # instances that can be created in a single (batch) request.
3435 &quot;a_key&quot;: &quot;A String&quot;,
3436 },
3437 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3438 # proximate cause of the error. Error reasons are unique within a particular
3439 # domain of errors. This should be at most 63 characters and match a
3440 # regular expression of `A-Z+[A-Z0-9]`, which represents
3441 # UPPER_SNAKE_CASE.
3442 },
3443 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3444 #
3445 # For example, if a quota check failed with an error indicating the calling
3446 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3447 # directly to the right place in the developer console to flip the bit.
3448 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3449 { # Describes a URL link.
3450 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3451 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3452 },
3453 ],
3454 },
3455 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3456 # which can be attached to an RPC error.
3457 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3458 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3459 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3460 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3461 },
3462 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3463 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3464 &quot;a_key&quot;: &quot;A String&quot;,
3465 },
3466 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3467 # type or metric.
3468 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3469 # or metric.
3470 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3471 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3472 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3473 },
3474 },
3475 ],
3476 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3477 # This property is optional.
3478 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3479 },
3480 ],
3481 },
3482 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Show timestamp only if there is an error.RFC3339
3483 # text format.
3484 },
3485 },
3486 },
3487 },
3488 &quot;zoneConfigurations&quot;: { # Map of zone configurations
3489 # Key: name of the zone
3490 # Value: ZoneConfiguration
3491 &quot;a_key&quot;: { # Config for a zone that the HaController may use for running the VM
3492 # instance.
3493 &quot;nodeAffinities&quot;: [ # A set of node affinity configurations. Refer toConfiguring node
3494 # affinity for more information.
3495 # Overrides reservationAffinity.
3496 { # Node Affinity: the configuration of desired nodes onto which the
3497 # Instance could be scheduled.
3498 # This message should be an exact copy of the Instances representation
3499 # of NodeAffinity.
3500 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
3501 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
3502 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
3503 &quot;A String&quot;,
3504 ],
3505 },
3506 ],
3507 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that the instance can consume from.
3508 # This message should be an exact copy of the Instances representation
3509 # of AllocationAffinity.
3510 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
3511 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
3512 # Consuming reserved instances for examples.
3513 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
3514 # the name of your reservation as its value.
3515 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
3516 # either a name to a reservation in the same project or
3517 # &quot;projects/different-project/reservations/some-reservation-name&quot; to
3518 # target a shared reservation in the same zone but in a different
3519 # project.
3520 &quot;A String&quot;,
3521 ],
3522 },
3523 },
3524 },
3525 }
3526
3527 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3528 that if you must retry your request, the server will know to ignore the
3529 request if it has already been completed.
3530 updateMask: string, update_mask indicates fields to be updated as part of this request.
3531 x__xgafv: string, V1 error format.
3532 Allowed values
3533 1 - v1 error format
3534 2 - v2 error format
3535
3536 Returns:
3537 An object of the form:
3538
3539 { # Represents an Operation resource.
3540 #
3541 # Google Compute Engine has three Operation resources:
3542 #
3543 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3544 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3545 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3546 #
3547 # You can use an operation resource to manage asynchronous API requests.
3548 # For more information, readHandling
3549 # API responses.
3550 #
3551 # Operations can be global, regional or zonal.
3552 #
3553 # - For global operations, use the `globalOperations`
3554 # resource.
3555 # - For regional operations, use the
3556 # `regionOperations` resource.
3557 # - For zonal operations, use
3558 # the `zoneOperations` resource.
3559 #
3560 #
3561 #
3562 # For more information, read
3563 # Global, Regional, and Zonal Resources.
3564 #
3565 # Note that completed Operation resources have a limited
3566 # retention period.
3567 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3568 # Not present otherwise.
3569 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3570 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3571 # set when the operation is created.
3572 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3573 # text format.
3574 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3575 # this field will be populated.
3576 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3577 # operation.
3578 {
3579 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3580 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3581 # details. There is a set of defined message types to use for providing
3582 # details.The syntax depends on the error code. For example,
3583 # QuotaExceededInfo will have details when the error code is
3584 # QUOTA_EXCEEDED.
3585 {
3586 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3587 #
3588 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3589 # is not enabled:
3590 #
3591 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3592 # &quot;domain&quot;: &quot;googleapis.com&quot;
3593 # &quot;metadata&quot;: {
3594 # &quot;resource&quot;: &quot;projects/123&quot;,
3595 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3596 # }
3597 # }
3598 #
3599 # This response indicates that the pubsub.googleapis.com API is not enabled.
3600 #
3601 # Example of an error that is returned when attempting to create a Spanner
3602 # instance in a region that is out of stock:
3603 #
3604 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3605 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3606 # &quot;metadata&quot;: {
3607 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3608 # }
3609 # }
3610 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3611 # is typically the registered service name of the tool or product that
3612 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3613 # generated by some common infrastructure, the error domain must be a
3614 # globally unique value that identifies the infrastructure. For Google API
3615 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3616 &quot;metadatas&quot;: { # Additional structured details about this error.
3617 #
3618 # Keys must match a regular expression of `a-z+` but should
3619 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3620 # length. When identifying the current value of an exceeded limit, the units
3621 # should be contained in the key, not the value. For example, rather than
3622 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3623 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3624 # instances that can be created in a single (batch) request.
3625 &quot;a_key&quot;: &quot;A String&quot;,
3626 },
3627 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3628 # proximate cause of the error. Error reasons are unique within a particular
3629 # domain of errors. This should be at most 63 characters and match a
3630 # regular expression of `A-Z+[A-Z0-9]`, which represents
3631 # UPPER_SNAKE_CASE.
3632 },
3633 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3634 #
3635 # For example, if a quota check failed with an error indicating the calling
3636 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3637 # directly to the right place in the developer console to flip the bit.
3638 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3639 { # Describes a URL link.
3640 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3641 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3642 },
3643 ],
3644 },
3645 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3646 # which can be attached to an RPC error.
3647 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3648 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3649 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3650 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3651 },
3652 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3653 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3654 &quot;a_key&quot;: &quot;A String&quot;,
3655 },
3656 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3657 # type or metric.
3658 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3659 # or metric.
3660 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3661 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3662 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3663 },
3664 },
3665 ],
3666 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3667 # This property is optional.
3668 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3669 },
3670 ],
3671 },
3672 &quot;getVersionOperationMetadata&quot;: {
3673 &quot;inlineSbomInfo&quot;: {
3674 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3675 # appropriate identifiers.
3676 &quot;a_key&quot;: &quot;A String&quot;,
3677 },
3678 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3679 # identifiers.
3680 &quot;a_key&quot;: &quot;A String&quot;,
3681 },
3682 },
3683 },
3684 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3685 # message that was returned, such as `NOT FOUND`.
3686 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3687 # status code that was returned. For example, a `404` means the
3688 # resource was not found.
3689 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3690 # defined by the server.
3691 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3692 # This value is inRFC3339
3693 # text format.
3694 &quot;instancesBulkInsertOperationMetadata&quot;: {
3695 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3696 # Example key: zones/us-central1-a
3697 &quot;a_key&quot;: {
3698 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3699 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3700 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3701 # error.
3702 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3703 # if the flow is rolling forward or rolling back.
3704 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3705 },
3706 },
3707 },
3708 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3709 # Operation resources.
3710 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3711 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3712 # group of operations results from a `bulkInsert` API request.
3713 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3714 # `update`, or `delete`, and so on.
3715 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3716 # There is no requirement that this be linear or support any granularity of
3717 # operations. This should not be used to guess when the operation will be
3718 # complete. This number should monotonically increase as the operation
3719 # progresses.
3720 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3721 # applicable when performing regional operations.
3722 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3723 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3724 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3725 # this field will contain information on all underlying zonal actions and
3726 # their state.
3727 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3728 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3729 # Example key: zones/us-central1-a
3730 &quot;a_key&quot;: {
3731 &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
3732 # populated.
3733 # different programming environments, including REST APIs and RPC APIs. It is
3734 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3735 # three pieces of data: error code, error message, and error details.
3736 #
3737 # You can find out more about this error model and how to work with it in the
3738 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3739 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3740 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3741 # message types for APIs to use.
3742 {
3743 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3744 },
3745 ],
3746 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3747 # user-facing error message should be localized and sent in the
3748 # google.rpc.Status.details field, or localized by the client.
3749 },
3750 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3751 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3752 },
3753 },
3754 },
3755 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3756 # This value is inRFC3339
3757 # text format.
3758 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3759 # following:
3760 # `PENDING`, `RUNNING`, or `DONE`.
3761 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3762 # operation.
3763 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3764 # of the target resource.
3765 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3766 # operations related to creating a snapshot, this points to the disk
3767 # that the snapshot was created from.
3768 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3769 # `[email protected]` or
3770 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3771 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3772 # operation, this field will be populated.
3773 {
3774 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3775 # Engine returns NO_RESULTS_ON_PAGE if there
3776 # are no results in the response.
3777 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3778 # value format. For example:
3779 #
3780 # &quot;data&quot;: [
3781 # {
3782 # &quot;key&quot;: &quot;scope&quot;,
3783 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3784 # }
3785 {
3786 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3787 # returned. For example, for warnings where there are no results in a list
3788 # request for a particular zone, this key might be scope and
3789 # the key value might be the zone name. Other examples might be a key
3790 # indicating a deprecated resource and a suggested replacement, or a
3791 # warning about invalid network settings (for example, if an instance
3792 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3793 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3794 },
3795 ],
3796 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3797 },
3798 ],
3799 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3800 # applicable when performing per-zone operations.
3801 }</pre>
3802 </div>
3803
3804 </body></html>