Debian Codegraph @

docs/dyn/compute_v1.previewFeatures.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.previewFeatures.html">previewFeatures</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, previewFeature, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the details of the given PreviewFeature.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the details of the given PreviewFeature.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <p class="toc_element">
90 <code><a href="#update">update(project, previewFeature, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Patches the given PreviewFeature. This method is used to enable or disable</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(project, previewFeature, x__xgafv=None)</code>
100 <pre>Returns the details of the given PreviewFeature.
101
102 Args:
103 project: string, Project ID for this request. (required)
104 previewFeature: string, Name of the PreviewFeature for this request. (required)
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110 Returns:
111 An object of the form:
112
113 { # Represents a single Google Compute Engine preview feature.
114 &quot;activationStatus&quot;: &quot;A String&quot;, # Specifies whether the feature is enabled or disabled.
115 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
116 # text format.
117 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] Description of the feature.
118 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
119 # defined by the server.
120 &quot;kind&quot;: &quot;compute#previewFeature&quot;, # Output only. [Output only] The type of the feature. Always &quot;compute#previewFeature&quot; for
121 # preview features.
122 &quot;name&quot;: &quot;A String&quot;, # Name of the feature.
123 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Rollout operation of the feature.
124 &quot;rolloutInput&quot;: { # Represents the input for the rollout operation. # Input only. The input for the rollout operation.
125 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan
126 # Ex.
127 # organizations//locations/global/rolloutPlans/
128 # Ex.
129 # folders//locations/global/rolloutPlans/
130 # Ex.
131 # projects//locations/global/rolloutPlans/.
132 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
133 },
134 },
135 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
136 &quot;status&quot;: { # [Output Only] The status of the feature. # Output only. [Output only] Status of the feature.
137 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] The description of the feature.
138 &quot;helpLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Link to the public documentation for the feature.
139 &quot;releaseStatus&quot;: { # [Output Only] The release status of the feature.
140 &quot;stage&quot;: &quot;A String&quot;, # Output only. [Output Only] The stage of the feature.
141 &quot;updateDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of # Output only. The last date when a feature transitioned between ReleaseStatuses.
142 # day and time zone are either specified elsewhere or are insignificant. The
143 # date is relative to the Gregorian Calendar. This can represent one of the
144 # following:
145 #
146 # * A full date, with non-zero year, month, and day values.
147 # * A month and day, with a zero year (for example, an anniversary).
148 # * A year on its own, with a zero month and a zero day.
149 # * A year and month, with a zero day (for example, a credit card expiration
150 # date).
151 #
152 # Related types:
153 #
154 # * google.type.TimeOfDay
155 # * google.type.DateTime
156 # * google.protobuf.Timestamp
157 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
158 # to specify a year by itself or a year and month where the day isn&#x27;t
159 # significant.
160 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a
161 # month and day.
162 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without
163 # a year.
164 },
165 },
166 },
167 }</pre>
168 </div>
169
170 <div class="method">
171 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
172 <pre>Returns the details of the given PreviewFeature.
173
174 Args:
175 project: string, Project ID for this request. (required)
176 filter: string, A filter expression that filters resources listed in the response. Most
177 Compute resources support two types of filter expressions:
178 expressions that support regular expressions and expressions that follow
179 API improvement proposal AIP-160.
180 These two types of filter expressions cannot be mixed in one request.
181
182 If you want to use AIP-160, your expression must specify the field name, an
183 operator, and the value that you want to use for filtering. The value
184 must be a string, a number, or a boolean. The operator
185 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
186
187 For example, if you are filtering Compute Engine instances, you can
188 exclude instances named `example-instance` by specifying
189 `name != example-instance`.
190
191 The `:*` comparison can be used to test whether a key has been defined.
192 For example, to find all objects with `owner` label use:
193 ```
194 labels.owner:*
195 ```
196
197 You can also filter nested fields. For example, you could specify
198 `scheduling.automaticRestart = false` to include instances only
199 if they are not scheduled for automatic restarts. You can use filtering
200 on nested fields to filter based onresource labels.
201
202 To filter on multiple expressions, provide each separate expression within
203 parentheses. For example:
204 ```
205 (scheduling.automaticRestart = true)
206 (cpuPlatform = &quot;Intel Skylake&quot;)
207 ```
208 By default, each expression is an `AND` expression. However, you
209 can include `AND` and `OR` expressions explicitly.
210 For example:
211 ```
212 (cpuPlatform = &quot;Intel Skylake&quot;) OR
213 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
214 (scheduling.automaticRestart = true)
215 ```
216
217 If you want to use a regular expression, use the `eq` (equal) or `ne`
218 (not equal) operator against a single un-parenthesized expression with or
219 without quotes or against multiple parenthesized expressions. Examples:
220
221 `fieldname eq unquoted literal`
222 `fieldname eq &#x27;single quoted literal&#x27;`
223 `fieldname eq &quot;double quoted literal&quot;`
224 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
225
226 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
227 The literal value must match the entire field.
228
229 For example, to filter for instances that do not end with name &quot;instance&quot;,
230 you would use `name ne .*instance`.
231
232 You cannot combine constraints on multiple fields using regular
233 expressions.
234 maxResults: integer, The maximum number of results per page that should be returned.
235 If the number of available results is larger than `maxResults`,
236 Compute Engine returns a `nextPageToken` that can be used to get
237 the next page of results in subsequent list requests. Acceptable values are
238 `0` to `500`, inclusive. (Default: `500`)
239 orderBy: string, Sorts list results by a certain order. By default, results
240 are returned in alphanumerical order based on the resource name.
241
242 You can also sort results in descending order based on the creation
243 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
244 results based on the `creationTimestamp` field in
245 reverse chronological order (newest result first). Use this to sort
246 resources like operations so that the newest operation is returned first.
247
248 Currently, only sorting by `name` or
249 `creationTimestamp desc` is supported.
250 pageToken: string, Specifies a page token to use. Set `pageToken` to the
251 `nextPageToken` returned by a previous list request to get
252 the next page of results.
253 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
254 of failure. The default value is false.
255
256 For example, when partial success behavior is enabled, aggregatedList for a
257 single zone scope either returns all resources in the zone or no resources,
258 with an error code.
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264 Returns:
265 An object of the form:
266
267 {
268 &quot;etag&quot;: &quot;A String&quot;,
269 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
270 &quot;items&quot;: [ # A list of PreviewFeature resources.
271 { # Represents a single Google Compute Engine preview feature.
272 &quot;activationStatus&quot;: &quot;A String&quot;, # Specifies whether the feature is enabled or disabled.
273 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
274 # text format.
275 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] Description of the feature.
276 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
277 # defined by the server.
278 &quot;kind&quot;: &quot;compute#previewFeature&quot;, # Output only. [Output only] The type of the feature. Always &quot;compute#previewFeature&quot; for
279 # preview features.
280 &quot;name&quot;: &quot;A String&quot;, # Name of the feature.
281 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Rollout operation of the feature.
282 &quot;rolloutInput&quot;: { # Represents the input for the rollout operation. # Input only. The input for the rollout operation.
283 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan
284 # Ex.
285 # organizations//locations/global/rolloutPlans/
286 # Ex.
287 # folders//locations/global/rolloutPlans/
288 # Ex.
289 # projects//locations/global/rolloutPlans/.
290 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
291 },
292 },
293 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
294 &quot;status&quot;: { # [Output Only] The status of the feature. # Output only. [Output only] Status of the feature.
295 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] The description of the feature.
296 &quot;helpLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Link to the public documentation for the feature.
297 &quot;releaseStatus&quot;: { # [Output Only] The release status of the feature.
298 &quot;stage&quot;: &quot;A String&quot;, # Output only. [Output Only] The stage of the feature.
299 &quot;updateDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of # Output only. The last date when a feature transitioned between ReleaseStatuses.
300 # day and time zone are either specified elsewhere or are insignificant. The
301 # date is relative to the Gregorian Calendar. This can represent one of the
302 # following:
303 #
304 # * A full date, with non-zero year, month, and day values.
305 # * A month and day, with a zero year (for example, an anniversary).
306 # * A year on its own, with a zero month and a zero day.
307 # * A year and month, with a zero day (for example, a credit card expiration
308 # date).
309 #
310 # Related types:
311 #
312 # * google.type.TimeOfDay
313 # * google.type.DateTime
314 # * google.protobuf.Timestamp
315 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
316 # to specify a year by itself or a year and month where the day isn&#x27;t
317 # significant.
318 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a
319 # month and day.
320 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without
321 # a year.
322 },
323 },
324 },
325 },
326 ],
327 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
328 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
329 # the query parameter pageToken in the next list request.
330 # Subsequent list requests will have their own nextPageToken to
331 # continue paging through the results.
332 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
333 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
334 # end_interface: MixerListResponseWithEtagBuilder
335 &quot;A String&quot;,
336 ],
337 &quot;warning&quot;: { # [Output Only] Informational warning message.
338 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
339 # Engine returns NO_RESULTS_ON_PAGE if there
340 # are no results in the response.
341 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
342 # value format. For example:
343 #
344 # &quot;data&quot;: [
345 # {
346 # &quot;key&quot;: &quot;scope&quot;,
347 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
348 # }
349 {
350 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
351 # returned. For example, for warnings where there are no results in a list
352 # request for a particular zone, this key might be scope and
353 # the key value might be the zone name. Other examples might be a key
354 # indicating a deprecated resource and a suggested replacement, or a
355 # warning about invalid network settings (for example, if an instance
356 # attempts to perform IP forwarding but is not enabled for IP forwarding).
357 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
358 },
359 ],
360 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
361 },
362 }</pre>
363 </div>
364
365 <div class="method">
366 <code class="details" id="list_next">list_next()</code>
367 <pre>Retrieves the next page of results.
368
369 Args:
370 previous_request: The request for the previous page. (required)
371 previous_response: The response from the request for the previous page. (required)
372
373 Returns:
374 A request object that you can call &#x27;execute()&#x27; on to request the next
375 page. Returns None if there are no more items in the collection.
376 </pre>
377 </div>
378
379 <div class="method">
380 <code class="details" id="update">update(project, previewFeature, body=None, requestId=None, x__xgafv=None)</code>
381 <pre>Patches the given PreviewFeature. This method is used to enable or disable
382 a PreviewFeature.
383
384 Args:
385 project: string, Project ID for this request. (required)
386 previewFeature: string, Name of the PreviewFeature for this request. (required)
387 body: object, The request body.
388 The object takes the form of:
389
390 { # Represents a single Google Compute Engine preview feature.
391 &quot;activationStatus&quot;: &quot;A String&quot;, # Specifies whether the feature is enabled or disabled.
392 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
393 # text format.
394 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] Description of the feature.
395 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
396 # defined by the server.
397 &quot;kind&quot;: &quot;compute#previewFeature&quot;, # Output only. [Output only] The type of the feature. Always &quot;compute#previewFeature&quot; for
398 # preview features.
399 &quot;name&quot;: &quot;A String&quot;, # Name of the feature.
400 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Rollout operation of the feature.
401 &quot;rolloutInput&quot;: { # Represents the input for the rollout operation. # Input only. The input for the rollout operation.
402 &quot;name&quot;: &quot;A String&quot;, # The name of the rollout plan
403 # Ex.
404 # organizations//locations/global/rolloutPlans/
405 # Ex.
406 # folders//locations/global/rolloutPlans/
407 # Ex.
408 # projects//locations/global/rolloutPlans/.
409 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Predefined rollout plan.
410 },
411 },
412 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
413 &quot;status&quot;: { # [Output Only] The status of the feature. # Output only. [Output only] Status of the feature.
414 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] The description of the feature.
415 &quot;helpLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Link to the public documentation for the feature.
416 &quot;releaseStatus&quot;: { # [Output Only] The release status of the feature.
417 &quot;stage&quot;: &quot;A String&quot;, # Output only. [Output Only] The stage of the feature.
418 &quot;updateDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of # Output only. The last date when a feature transitioned between ReleaseStatuses.
419 # day and time zone are either specified elsewhere or are insignificant. The
420 # date is relative to the Gregorian Calendar. This can represent one of the
421 # following:
422 #
423 # * A full date, with non-zero year, month, and day values.
424 # * A month and day, with a zero year (for example, an anniversary).
425 # * A year on its own, with a zero month and a zero day.
426 # * A year and month, with a zero day (for example, a credit card expiration
427 # date).
428 #
429 # Related types:
430 #
431 # * google.type.TimeOfDay
432 # * google.type.DateTime
433 # * google.protobuf.Timestamp
434 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
435 # to specify a year by itself or a year and month where the day isn&#x27;t
436 # significant.
437 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a
438 # month and day.
439 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without
440 # a year.
441 },
442 },
443 },
444 }
445
446 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
447 that if you must retry your request, the server will know to ignore the
448 request if it has already been completed.
449
450 For example, consider a situation where you make an initial request and
451 the request times out. If you make the request again with the same
452 request ID, the server can check if original operation with the same
453 request ID was received, and if so, will ignore the second request. This
454 prevents clients from accidentally creating duplicate commitments.
455
456 The request ID must be
457 a valid UUID with the exception that zero UUID is not supported
458 (00000000-0000-0000-0000-000000000000).
459 x__xgafv: string, V1 error format.
460 Allowed values
461 1 - v1 error format
462 2 - v2 error format
463
464 Returns:
465 An object of the form:
466
467 { # Represents an Operation resource.
468 #
469 # Google Compute Engine has three Operation resources:
470 #
471 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
472 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
473 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
474 #
475 # You can use an operation resource to manage asynchronous API requests.
476 # For more information, readHandling
477 # API responses.
478 #
479 # Operations can be global, regional or zonal.
480 #
481 # - For global operations, use the `globalOperations`
482 # resource.
483 # - For regional operations, use the
484 # `regionOperations` resource.
485 # - For zonal operations, use
486 # the `zoneOperations` resource.
487 #
488 #
489 #
490 # For more information, read
491 # Global, Regional, and Zonal Resources.
492 #
493 # Note that completed Operation resources have a limited
494 # retention period.
495 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
496 # Not present otherwise.
497 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
498 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
499 # set when the operation is created.
500 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
501 # text format.
502 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
503 # this field will be populated.
504 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
505 # operation.
506 {
507 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
508 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
509 # details. There is a set of defined message types to use for providing
510 # details.The syntax depends on the error code. For example,
511 # QuotaExceededInfo will have details when the error code is
512 # QUOTA_EXCEEDED.
513 {
514 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
515 #
516 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
517 # is not enabled:
518 #
519 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
520 # &quot;domain&quot;: &quot;googleapis.com&quot;
521 # &quot;metadata&quot;: {
522 # &quot;resource&quot;: &quot;projects/123&quot;,
523 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
524 # }
525 # }
526 #
527 # This response indicates that the pubsub.googleapis.com API is not enabled.
528 #
529 # Example of an error that is returned when attempting to create a Spanner
530 # instance in a region that is out of stock:
531 #
532 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
533 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
534 # &quot;metadata&quot;: {
535 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
536 # }
537 # }
538 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
539 # is typically the registered service name of the tool or product that
540 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
541 # generated by some common infrastructure, the error domain must be a
542 # globally unique value that identifies the infrastructure. For Google API
543 # infrastructure, the error domain is &quot;googleapis.com&quot;.
544 &quot;metadatas&quot;: { # Additional structured details about this error.
545 #
546 # Keys must match a regular expression of `a-z+` but should
547 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
548 # length. When identifying the current value of an exceeded limit, the units
549 # should be contained in the key, not the value. For example, rather than
550 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
551 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
552 # instances that can be created in a single (batch) request.
553 &quot;a_key&quot;: &quot;A String&quot;,
554 },
555 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
556 # proximate cause of the error. Error reasons are unique within a particular
557 # domain of errors. This should be at most 63 characters and match a
558 # regular expression of `A-Z+[A-Z0-9]`, which represents
559 # UPPER_SNAKE_CASE.
560 },
561 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
562 #
563 # For example, if a quota check failed with an error indicating the calling
564 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
565 # directly to the right place in the developer console to flip the bit.
566 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
567 { # Describes a URL link.
568 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
569 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
570 },
571 ],
572 },
573 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
574 # which can be attached to an RPC error.
575 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
576 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
577 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
578 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
579 },
580 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
581 &quot;dimensions&quot;: { # The map holding related quota dimensions.
582 &quot;a_key&quot;: &quot;A String&quot;,
583 },
584 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
585 # type or metric.
586 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
587 # or metric.
588 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
589 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
590 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
591 },
592 },
593 ],
594 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
595 # This property is optional.
596 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
597 },
598 ],
599 },
600 &quot;getVersionOperationMetadata&quot;: {
601 &quot;inlineSbomInfo&quot;: {
602 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
603 # appropriate identifiers.
604 &quot;a_key&quot;: &quot;A String&quot;,
605 },
606 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
607 # identifiers.
608 &quot;a_key&quot;: &quot;A String&quot;,
609 },
610 },
611 },
612 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
613 # message that was returned, such as `NOT FOUND`.
614 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
615 # status code that was returned. For example, a `404` means the
616 # resource was not found.
617 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
618 # defined by the server.
619 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
620 # This value is inRFC3339
621 # text format.
622 &quot;instancesBulkInsertOperationMetadata&quot;: {
623 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
624 # Example key: zones/us-central1-a
625 &quot;a_key&quot;: {
626 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
627 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
628 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
629 # error.
630 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
631 # if the flow is rolling forward or rolling back.
632 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
633 },
634 },
635 },
636 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
637 # Operation resources.
638 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
639 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
640 # group of operations results from a `bulkInsert` API request.
641 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
642 # `update`, or `delete`, and so on.
643 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
644 # There is no requirement that this be linear or support any granularity of
645 # operations. This should not be used to guess when the operation will be
646 # complete. This number should monotonically increase as the operation
647 # progresses.
648 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
649 # applicable when performing regional operations.
650 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
651 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
652 # this field will contain information on all underlying zonal actions and
653 # their state.
654 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
655 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
656 # Example key: zones/us-central1-a
657 &quot;a_key&quot;: {
658 &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
659 # populated.
660 # different programming environments, including REST APIs and RPC APIs. It is
661 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
662 # three pieces of data: error code, error message, and error details.
663 #
664 # You can find out more about this error model and how to work with it in the
665 # [API Design Guide](https://cloud.google.com/apis/design/errors).
666 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
667 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
668 # message types for APIs to use.
669 {
670 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
671 },
672 ],
673 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
674 # user-facing error message should be localized and sent in the
675 # google.rpc.Status.details field, or localized by the client.
676 },
677 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
678 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
679 },
680 },
681 },
682 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
683 # This value is inRFC3339
684 # text format.
685 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
686 # following:
687 # `PENDING`, `RUNNING`, or `DONE`.
688 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
689 # operation.
690 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
691 # of the target resource.
692 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
693 # operations related to creating a snapshot, this points to the disk
694 # that the snapshot was created from.
695 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
696 # `[email protected]` or
697 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
698 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
699 # operation, this field will be populated.
700 {
701 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
702 # Engine returns NO_RESULTS_ON_PAGE if there
703 # are no results in the response.
704 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
705 # value format. For example:
706 #
707 # &quot;data&quot;: [
708 # {
709 # &quot;key&quot;: &quot;scope&quot;,
710 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
711 # }
712 {
713 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
714 # returned. For example, for warnings where there are no results in a list
715 # request for a particular zone, this key might be scope and
716 # the key value might be the zone name. Other examples might be a key
717 # indicating a deprecated resource and a suggested replacement, or a
718 # warning about invalid network settings (for example, if an instance
719 # attempts to perform IP forwarding but is not enabled for IP forwarding).
720 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
721 },
722 ],
723 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
724 },
725 ],
726 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
727 # applicable when performing per-zone operations.
728 }</pre>
729 </div>
730
731 </body></html>