Debian Codegraph @

docs/dyn/compute_beta.publicAdvertisedPrefixes.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.publicAdvertisedPrefixes.html">publicAdvertisedPrefixes</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#announce">announce(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Announces the specified PublicAdvertisedPrefix</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes the specified PublicAdvertisedPrefix</p>
86 <p class="toc_element">
87 <code><a href="#get">get(project, publicAdvertisedPrefix, x__xgafv=None)</a></code></p>
88 <p class="firstline">Returns the specified PublicAdvertisedPrefix resource.</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Creates a PublicAdvertisedPrefix in the specified project</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Lists the PublicAdvertisedPrefixes for a project.</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#patch">patch(project, publicAdvertisedPrefix, body=None, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Patches the specified Router resource with the data included in the</p>
101 <p class="toc_element">
102 <code><a href="#withdraw">withdraw(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Withdraws the specified PublicAdvertisedPrefix</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="announce">announce(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</code>
107 <pre>Announces the specified PublicAdvertisedPrefix
108
109 Args:
110 project: string, Project ID for this request. (required)
111 publicAdvertisedPrefix: string, The name of the public advertised prefix. It should comply with RFC1035. (required)
112 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
113 that if you must retry your request, the server will know to ignore the
114 request if it has already been completed.
115
116 For example, consider a situation where you make an initial request and
117 the request times out. If you make the request again with the same
118 request ID, the server can check if original operation with the same
119 request ID was received, and if so, will ignore the second request. This
120 prevents clients from accidentally creating duplicate commitments.
121
122 The request ID must be
123 a valid UUID with the exception that zero UUID is not supported
124 (00000000-0000-0000-0000-000000000000).
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 { # Represents an Operation resource.
134 #
135 # Google Compute Engine has three Operation resources:
136 #
137 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
138 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
139 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
140 #
141 # You can use an operation resource to manage asynchronous API requests.
142 # For more information, readHandling
143 # API responses.
144 #
145 # Operations can be global, regional or zonal.
146 #
147 # - For global operations, use the `globalOperations`
148 # resource.
149 # - For regional operations, use the
150 # `regionOperations` resource.
151 # - For zonal operations, use
152 # the `zoneOperations` resource.
153 #
154 #
155 #
156 # For more information, read
157 # Global, Regional, and Zonal Resources.
158 #
159 # Note that completed Operation resources have a limited
160 # retention period.
161 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
162 # Not present otherwise.
163 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
164 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
165 # set when the operation is created.
166 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
167 # text format.
168 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
169 # this field will be populated.
170 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
171 # operation.
172 {
173 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
174 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
175 # details. There is a set of defined message types to use for providing
176 # details.The syntax depends on the error code. For example,
177 # QuotaExceededInfo will have details when the error code is
178 # QUOTA_EXCEEDED.
179 {
180 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
181 #
182 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
183 # is not enabled:
184 #
185 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
186 # &quot;domain&quot;: &quot;googleapis.com&quot;
187 # &quot;metadata&quot;: {
188 # &quot;resource&quot;: &quot;projects/123&quot;,
189 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
190 # }
191 # }
192 #
193 # This response indicates that the pubsub.googleapis.com API is not enabled.
194 #
195 # Example of an error that is returned when attempting to create a Spanner
196 # instance in a region that is out of stock:
197 #
198 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
199 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
200 # &quot;metadata&quot;: {
201 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
202 # }
203 # }
204 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
205 # is typically the registered service name of the tool or product that
206 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
207 # generated by some common infrastructure, the error domain must be a
208 # globally unique value that identifies the infrastructure. For Google API
209 # infrastructure, the error domain is &quot;googleapis.com&quot;.
210 &quot;metadatas&quot;: { # Additional structured details about this error.
211 #
212 # Keys must match a regular expression of `a-z+` but should
213 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
214 # length. When identifying the current value of an exceeded limit, the units
215 # should be contained in the key, not the value. For example, rather than
216 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
217 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
218 # instances that can be created in a single (batch) request.
219 &quot;a_key&quot;: &quot;A String&quot;,
220 },
221 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
222 # proximate cause of the error. Error reasons are unique within a particular
223 # domain of errors. This should be at most 63 characters and match a
224 # regular expression of `A-Z+[A-Z0-9]`, which represents
225 # UPPER_SNAKE_CASE.
226 },
227 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
228 #
229 # For example, if a quota check failed with an error indicating the calling
230 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
231 # directly to the right place in the developer console to flip the bit.
232 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
233 { # Describes a URL link.
234 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
235 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
236 },
237 ],
238 },
239 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
240 # which can be attached to an RPC error.
241 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
242 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
243 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
244 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
245 },
246 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
247 &quot;dimensions&quot;: { # The map holding related quota dimensions.
248 &quot;a_key&quot;: &quot;A String&quot;,
249 },
250 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
251 # type or metric.
252 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
253 # or metric.
254 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
255 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
256 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
257 },
258 },
259 ],
260 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
261 # This property is optional.
262 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
263 },
264 ],
265 },
266 &quot;getVersionOperationMetadata&quot;: {
267 &quot;inlineSbomInfo&quot;: {
268 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
269 # appropriate identifiers.
270 &quot;a_key&quot;: &quot;A String&quot;,
271 },
272 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
273 # identifiers.
274 &quot;a_key&quot;: &quot;A String&quot;,
275 },
276 },
277 },
278 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
279 # message that was returned, such as `NOT FOUND`.
280 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
281 # status code that was returned. For example, a `404` means the
282 # resource was not found.
283 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
284 # defined by the server.
285 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
286 # This value is inRFC3339
287 # text format.
288 &quot;instancesBulkInsertOperationMetadata&quot;: {
289 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
290 # Example key: zones/us-central1-a
291 &quot;a_key&quot;: {
292 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
293 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
294 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
295 # error.
296 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
297 # if the flow is rolling forward or rolling back.
298 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
299 },
300 },
301 },
302 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
303 # Operation resources.
304 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
305 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
306 # group of operations results from a `bulkInsert` API request.
307 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
308 # `update`, or `delete`, and so on.
309 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
310 # There is no requirement that this be linear or support any granularity of
311 # operations. This should not be used to guess when the operation will be
312 # complete. This number should monotonically increase as the operation
313 # progresses.
314 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
315 # applicable when performing regional operations.
316 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
317 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
318 # this field will contain information on all underlying zonal actions and
319 # their state.
320 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
321 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
322 # Example key: zones/us-central1-a
323 &quot;a_key&quot;: {
324 &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
325 # populated.
326 # different programming environments, including REST APIs and RPC APIs. It is
327 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
328 # three pieces of data: error code, error message, and error details.
329 #
330 # You can find out more about this error model and how to work with it in the
331 # [API Design Guide](https://cloud.google.com/apis/design/errors).
332 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
333 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
334 # message types for APIs to use.
335 {
336 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
337 },
338 ],
339 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
340 # user-facing error message should be localized and sent in the
341 # google.rpc.Status.details field, or localized by the client.
342 },
343 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
344 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
345 },
346 },
347 },
348 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
349 # This value is inRFC3339
350 # text format.
351 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
352 # following:
353 # `PENDING`, `RUNNING`, or `DONE`.
354 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
355 # operation.
356 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
357 # of the target resource.
358 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
359 # operations related to creating a snapshot, this points to the disk
360 # that the snapshot was created from.
361 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
362 # `[email protected]` or
363 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
364 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
365 # operation, this field will be populated.
366 {
367 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
368 # Engine returns NO_RESULTS_ON_PAGE if there
369 # are no results in the response.
370 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
371 # value format. For example:
372 #
373 # &quot;data&quot;: [
374 # {
375 # &quot;key&quot;: &quot;scope&quot;,
376 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
377 # }
378 {
379 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
380 # returned. For example, for warnings where there are no results in a list
381 # request for a particular zone, this key might be scope and
382 # the key value might be the zone name. Other examples might be a key
383 # indicating a deprecated resource and a suggested replacement, or a
384 # warning about invalid network settings (for example, if an instance
385 # attempts to perform IP forwarding but is not enabled for IP forwarding).
386 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
387 },
388 ],
389 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
390 },
391 ],
392 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
393 # applicable when performing per-zone operations.
394 }</pre>
395 </div>
396
397 <div class="method">
398 <code class="details" id="close">close()</code>
399 <pre>Close httplib2 connections.</pre>
400 </div>
401
402 <div class="method">
403 <code class="details" id="delete">delete(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</code>
404 <pre>Deletes the specified PublicAdvertisedPrefix
405
406 Args:
407 project: string, Project ID for this request. (required)
408 publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to delete. (required)
409 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
410 that if you must retry your request, the server will know to ignore the
411 request if it has already been completed.
412
413 For example, consider a situation where you make an initial request and
414 the request times out. If you make the request again with the same
415 request ID, the server can check if original operation with the same
416 request ID was received, and if so, will ignore the second request. This
417 prevents clients from accidentally creating duplicate commitments.
418
419 The request ID must be
420 a valid UUID with the exception that zero UUID is not supported
421 (00000000-0000-0000-0000-000000000000).
422 x__xgafv: string, V1 error format.
423 Allowed values
424 1 - v1 error format
425 2 - v2 error format
426
427 Returns:
428 An object of the form:
429
430 { # Represents an Operation resource.
431 #
432 # Google Compute Engine has three Operation resources:
433 #
434 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
435 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
436 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
437 #
438 # You can use an operation resource to manage asynchronous API requests.
439 # For more information, readHandling
440 # API responses.
441 #
442 # Operations can be global, regional or zonal.
443 #
444 # - For global operations, use the `globalOperations`
445 # resource.
446 # - For regional operations, use the
447 # `regionOperations` resource.
448 # - For zonal operations, use
449 # the `zoneOperations` resource.
450 #
451 #
452 #
453 # For more information, read
454 # Global, Regional, and Zonal Resources.
455 #
456 # Note that completed Operation resources have a limited
457 # retention period.
458 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
459 # Not present otherwise.
460 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
461 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
462 # set when the operation is created.
463 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
464 # text format.
465 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
466 # this field will be populated.
467 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
468 # operation.
469 {
470 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
471 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
472 # details. There is a set of defined message types to use for providing
473 # details.The syntax depends on the error code. For example,
474 # QuotaExceededInfo will have details when the error code is
475 # QUOTA_EXCEEDED.
476 {
477 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
478 #
479 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
480 # is not enabled:
481 #
482 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
483 # &quot;domain&quot;: &quot;googleapis.com&quot;
484 # &quot;metadata&quot;: {
485 # &quot;resource&quot;: &quot;projects/123&quot;,
486 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
487 # }
488 # }
489 #
490 # This response indicates that the pubsub.googleapis.com API is not enabled.
491 #
492 # Example of an error that is returned when attempting to create a Spanner
493 # instance in a region that is out of stock:
494 #
495 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
496 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
497 # &quot;metadata&quot;: {
498 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
499 # }
500 # }
501 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
502 # is typically the registered service name of the tool or product that
503 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
504 # generated by some common infrastructure, the error domain must be a
505 # globally unique value that identifies the infrastructure. For Google API
506 # infrastructure, the error domain is &quot;googleapis.com&quot;.
507 &quot;metadatas&quot;: { # Additional structured details about this error.
508 #
509 # Keys must match a regular expression of `a-z+` but should
510 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
511 # length. When identifying the current value of an exceeded limit, the units
512 # should be contained in the key, not the value. For example, rather than
513 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
514 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
515 # instances that can be created in a single (batch) request.
516 &quot;a_key&quot;: &quot;A String&quot;,
517 },
518 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
519 # proximate cause of the error. Error reasons are unique within a particular
520 # domain of errors. This should be at most 63 characters and match a
521 # regular expression of `A-Z+[A-Z0-9]`, which represents
522 # UPPER_SNAKE_CASE.
523 },
524 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
525 #
526 # For example, if a quota check failed with an error indicating the calling
527 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
528 # directly to the right place in the developer console to flip the bit.
529 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
530 { # Describes a URL link.
531 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
532 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
533 },
534 ],
535 },
536 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
537 # which can be attached to an RPC error.
538 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
539 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
540 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
541 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
542 },
543 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
544 &quot;dimensions&quot;: { # The map holding related quota dimensions.
545 &quot;a_key&quot;: &quot;A String&quot;,
546 },
547 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
548 # type or metric.
549 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
550 # or metric.
551 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
552 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
553 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
554 },
555 },
556 ],
557 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
558 # This property is optional.
559 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
560 },
561 ],
562 },
563 &quot;getVersionOperationMetadata&quot;: {
564 &quot;inlineSbomInfo&quot;: {
565 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
566 # appropriate identifiers.
567 &quot;a_key&quot;: &quot;A String&quot;,
568 },
569 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
570 # identifiers.
571 &quot;a_key&quot;: &quot;A String&quot;,
572 },
573 },
574 },
575 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
576 # message that was returned, such as `NOT FOUND`.
577 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
578 # status code that was returned. For example, a `404` means the
579 # resource was not found.
580 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
581 # defined by the server.
582 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
583 # This value is inRFC3339
584 # text format.
585 &quot;instancesBulkInsertOperationMetadata&quot;: {
586 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
587 # Example key: zones/us-central1-a
588 &quot;a_key&quot;: {
589 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
590 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
591 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
592 # error.
593 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
594 # if the flow is rolling forward or rolling back.
595 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
596 },
597 },
598 },
599 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
600 # Operation resources.
601 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
602 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
603 # group of operations results from a `bulkInsert` API request.
604 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
605 # `update`, or `delete`, and so on.
606 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
607 # There is no requirement that this be linear or support any granularity of
608 # operations. This should not be used to guess when the operation will be
609 # complete. This number should monotonically increase as the operation
610 # progresses.
611 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
612 # applicable when performing regional operations.
613 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
614 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
615 # this field will contain information on all underlying zonal actions and
616 # their state.
617 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
618 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
619 # Example key: zones/us-central1-a
620 &quot;a_key&quot;: {
621 &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
622 # populated.
623 # different programming environments, including REST APIs and RPC APIs. It is
624 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
625 # three pieces of data: error code, error message, and error details.
626 #
627 # You can find out more about this error model and how to work with it in the
628 # [API Design Guide](https://cloud.google.com/apis/design/errors).
629 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
630 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
631 # message types for APIs to use.
632 {
633 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
634 },
635 ],
636 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
637 # user-facing error message should be localized and sent in the
638 # google.rpc.Status.details field, or localized by the client.
639 },
640 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
641 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
642 },
643 },
644 },
645 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
646 # This value is inRFC3339
647 # text format.
648 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
649 # following:
650 # `PENDING`, `RUNNING`, or `DONE`.
651 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
652 # operation.
653 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
654 # of the target resource.
655 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
656 # operations related to creating a snapshot, this points to the disk
657 # that the snapshot was created from.
658 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
659 # `[email protected]` or
660 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
661 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
662 # operation, this field will be populated.
663 {
664 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
665 # Engine returns NO_RESULTS_ON_PAGE if there
666 # are no results in the response.
667 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
668 # value format. For example:
669 #
670 # &quot;data&quot;: [
671 # {
672 # &quot;key&quot;: &quot;scope&quot;,
673 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
674 # }
675 {
676 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
677 # returned. For example, for warnings where there are no results in a list
678 # request for a particular zone, this key might be scope and
679 # the key value might be the zone name. Other examples might be a key
680 # indicating a deprecated resource and a suggested replacement, or a
681 # warning about invalid network settings (for example, if an instance
682 # attempts to perform IP forwarding but is not enabled for IP forwarding).
683 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
684 },
685 ],
686 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
687 },
688 ],
689 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
690 # applicable when performing per-zone operations.
691 }</pre>
692 </div>
693
694 <div class="method">
695 <code class="details" id="get">get(project, publicAdvertisedPrefix, x__xgafv=None)</code>
696 <pre>Returns the specified PublicAdvertisedPrefix resource.
697
698 Args:
699 project: string, Project ID for this request. (required)
700 publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to return. (required)
701 x__xgafv: string, V1 error format.
702 Allowed values
703 1 - v1 error format
704 2 - v2 error format
705
706 Returns:
707 An object of the form:
708
709 { # A public advertised prefix represents an aggregated IP prefix or netblock
710 # which customers bring to cloud. The IP prefix is a single unit of route
711 # advertisement and is announced globally to the internet.
712 &quot;byoipApiVersion&quot;: &quot;A String&quot;, # Output only. [Output Only] The version of BYOIP API.
713 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
714 # text format.
715 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
716 # create the resource.
717 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The address to be used for reverse DNS verification.
718 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
719 # This field is used in optimistic locking. This field will be ignored when
720 # inserting a new PublicAdvertisedPrefix. An up-to-date
721 # fingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with
722 # error 412 conditionNotMet.
723 #
724 # To see the latest fingerprint, make a get() request to
725 # retrieve a PublicAdvertisedPrefix.
726 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
727 # generates this identifier.
728 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The address range, in CIDR format, represented by this public advertised
729 # prefix.
730 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The internet access type for IPv6 Public Advertised Prefixes.
731 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.
732 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
733 # The name must be 1-63 characters long, and comply withRFC1035.
734 # Specifically, the name must be 1-63 characters long and match the regular
735 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
736 # character must be a lowercase letter, and all following characters must
737 # be a dash, lowercase letter, or digit, except the last character, which
738 # cannot be a dash.
739 &quot;pdpScope&quot;: &quot;A String&quot;, # Specifies how child public delegated prefix will be scoped. It could
740 # be one of following values:
741 #
742 #
743 # - `REGIONAL`: The public delegated prefix is regional only. The
744 # provisioning will take a few minutes.
745 # - `GLOBAL`: The public delegated prefix is global only. The
746 # provisioning will take ~4 weeks.
747 # - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
748 # BYOIP V1 legacy prefix. This is output only value and no longer
749 # supported in BYOIP V2.
750 &quot;publicDelegatedPrefixs&quot;: [ # Output only. [Output Only] The list of public delegated prefixes that exist for this
751 # public advertised prefix.
752 { # Represents a CIDR range which can be used to assign addresses.
753 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
754 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
755 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
756 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent,
757 # the prefix is global.
758 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are:
759 # INITIALIZING: The public delegated prefix is being initialized and
760 # addresses cannot be created yet.
761 # ANNOUNCED: The public delegated prefix is active.
762 },
763 ],
764 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
765 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
766 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix. Possible values include:
767 #
768 #
769 # - `INITIAL`: RPKI validation is complete.
770 # - `PTR_CONFIGURED`: User has configured the PTR.
771 # - `VALIDATED`: Reverse DNS lookup is successful.
772 # - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
773 # - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
774 # configured.
775 # - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
776 # - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
777 }</pre>
778 </div>
779
780 <div class="method">
781 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
782 <pre>Creates a PublicAdvertisedPrefix in the specified project
783 using the parameters that are included in the request.
784
785 Args:
786 project: string, Project ID for this request. (required)
787 body: object, The request body.
788 The object takes the form of:
789
790 { # A public advertised prefix represents an aggregated IP prefix or netblock
791 # which customers bring to cloud. The IP prefix is a single unit of route
792 # advertisement and is announced globally to the internet.
793 &quot;byoipApiVersion&quot;: &quot;A String&quot;, # Output only. [Output Only] The version of BYOIP API.
794 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
795 # text format.
796 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
797 # create the resource.
798 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The address to be used for reverse DNS verification.
799 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
800 # This field is used in optimistic locking. This field will be ignored when
801 # inserting a new PublicAdvertisedPrefix. An up-to-date
802 # fingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with
803 # error 412 conditionNotMet.
804 #
805 # To see the latest fingerprint, make a get() request to
806 # retrieve a PublicAdvertisedPrefix.
807 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
808 # generates this identifier.
809 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The address range, in CIDR format, represented by this public advertised
810 # prefix.
811 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The internet access type for IPv6 Public Advertised Prefixes.
812 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.
813 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
814 # The name must be 1-63 characters long, and comply withRFC1035.
815 # Specifically, the name must be 1-63 characters long and match the regular
816 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
817 # character must be a lowercase letter, and all following characters must
818 # be a dash, lowercase letter, or digit, except the last character, which
819 # cannot be a dash.
820 &quot;pdpScope&quot;: &quot;A String&quot;, # Specifies how child public delegated prefix will be scoped. It could
821 # be one of following values:
822 #
823 #
824 # - `REGIONAL`: The public delegated prefix is regional only. The
825 # provisioning will take a few minutes.
826 # - `GLOBAL`: The public delegated prefix is global only. The
827 # provisioning will take ~4 weeks.
828 # - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
829 # BYOIP V1 legacy prefix. This is output only value and no longer
830 # supported in BYOIP V2.
831 &quot;publicDelegatedPrefixs&quot;: [ # Output only. [Output Only] The list of public delegated prefixes that exist for this
832 # public advertised prefix.
833 { # Represents a CIDR range which can be used to assign addresses.
834 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
835 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
836 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
837 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent,
838 # the prefix is global.
839 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are:
840 # INITIALIZING: The public delegated prefix is being initialized and
841 # addresses cannot be created yet.
842 # ANNOUNCED: The public delegated prefix is active.
843 },
844 ],
845 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
846 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
847 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix. Possible values include:
848 #
849 #
850 # - `INITIAL`: RPKI validation is complete.
851 # - `PTR_CONFIGURED`: User has configured the PTR.
852 # - `VALIDATED`: Reverse DNS lookup is successful.
853 # - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
854 # - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
855 # configured.
856 # - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
857 # - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
858 }
859
860 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
861 that if you must retry your request, the server will know to ignore the
862 request if it has already been completed.
863
864 For example, consider a situation where you make an initial request and
865 the request times out. If you make the request again with the same
866 request ID, the server can check if original operation with the same
867 request ID was received, and if so, will ignore the second request. This
868 prevents clients from accidentally creating duplicate commitments.
869
870 The request ID must be
871 a valid UUID with the exception that zero UUID is not supported
872 (00000000-0000-0000-0000-000000000000).
873 x__xgafv: string, V1 error format.
874 Allowed values
875 1 - v1 error format
876 2 - v2 error format
877
878 Returns:
879 An object of the form:
880
881 { # Represents an Operation resource.
882 #
883 # Google Compute Engine has three Operation resources:
884 #
885 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
886 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
887 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
888 #
889 # You can use an operation resource to manage asynchronous API requests.
890 # For more information, readHandling
891 # API responses.
892 #
893 # Operations can be global, regional or zonal.
894 #
895 # - For global operations, use the `globalOperations`
896 # resource.
897 # - For regional operations, use the
898 # `regionOperations` resource.
899 # - For zonal operations, use
900 # the `zoneOperations` resource.
901 #
902 #
903 #
904 # For more information, read
905 # Global, Regional, and Zonal Resources.
906 #
907 # Note that completed Operation resources have a limited
908 # retention period.
909 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
910 # Not present otherwise.
911 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
912 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
913 # set when the operation is created.
914 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
915 # text format.
916 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
917 # this field will be populated.
918 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
919 # operation.
920 {
921 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
922 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
923 # details. There is a set of defined message types to use for providing
924 # details.The syntax depends on the error code. For example,
925 # QuotaExceededInfo will have details when the error code is
926 # QUOTA_EXCEEDED.
927 {
928 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
929 #
930 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
931 # is not enabled:
932 #
933 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
934 # &quot;domain&quot;: &quot;googleapis.com&quot;
935 # &quot;metadata&quot;: {
936 # &quot;resource&quot;: &quot;projects/123&quot;,
937 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
938 # }
939 # }
940 #
941 # This response indicates that the pubsub.googleapis.com API is not enabled.
942 #
943 # Example of an error that is returned when attempting to create a Spanner
944 # instance in a region that is out of stock:
945 #
946 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
947 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
948 # &quot;metadata&quot;: {
949 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
950 # }
951 # }
952 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
953 # is typically the registered service name of the tool or product that
954 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
955 # generated by some common infrastructure, the error domain must be a
956 # globally unique value that identifies the infrastructure. For Google API
957 # infrastructure, the error domain is &quot;googleapis.com&quot;.
958 &quot;metadatas&quot;: { # Additional structured details about this error.
959 #
960 # Keys must match a regular expression of `a-z+` but should
961 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
962 # length. When identifying the current value of an exceeded limit, the units
963 # should be contained in the key, not the value. For example, rather than
964 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
965 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
966 # instances that can be created in a single (batch) request.
967 &quot;a_key&quot;: &quot;A String&quot;,
968 },
969 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
970 # proximate cause of the error. Error reasons are unique within a particular
971 # domain of errors. This should be at most 63 characters and match a
972 # regular expression of `A-Z+[A-Z0-9]`, which represents
973 # UPPER_SNAKE_CASE.
974 },
975 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
976 #
977 # For example, if a quota check failed with an error indicating the calling
978 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
979 # directly to the right place in the developer console to flip the bit.
980 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
981 { # Describes a URL link.
982 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
983 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
984 },
985 ],
986 },
987 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
988 # which can be attached to an RPC error.
989 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
990 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
991 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
992 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
993 },
994 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
995 &quot;dimensions&quot;: { # The map holding related quota dimensions.
996 &quot;a_key&quot;: &quot;A String&quot;,
997 },
998 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
999 # type or metric.
1000 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1001 # or metric.
1002 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1003 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1004 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1005 },
1006 },
1007 ],
1008 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1009 # This property is optional.
1010 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1011 },
1012 ],
1013 },
1014 &quot;getVersionOperationMetadata&quot;: {
1015 &quot;inlineSbomInfo&quot;: {
1016 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1017 # appropriate identifiers.
1018 &quot;a_key&quot;: &quot;A String&quot;,
1019 },
1020 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1021 # identifiers.
1022 &quot;a_key&quot;: &quot;A String&quot;,
1023 },
1024 },
1025 },
1026 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1027 # message that was returned, such as `NOT FOUND`.
1028 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1029 # status code that was returned. For example, a `404` means the
1030 # resource was not found.
1031 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1032 # defined by the server.
1033 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1034 # This value is inRFC3339
1035 # text format.
1036 &quot;instancesBulkInsertOperationMetadata&quot;: {
1037 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1038 # Example key: zones/us-central1-a
1039 &quot;a_key&quot;: {
1040 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1041 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1042 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1043 # error.
1044 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1045 # if the flow is rolling forward or rolling back.
1046 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1047 },
1048 },
1049 },
1050 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1051 # Operation resources.
1052 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1053 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1054 # group of operations results from a `bulkInsert` API request.
1055 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1056 # `update`, or `delete`, and so on.
1057 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1058 # There is no requirement that this be linear or support any granularity of
1059 # operations. This should not be used to guess when the operation will be
1060 # complete. This number should monotonically increase as the operation
1061 # progresses.
1062 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1063 # applicable when performing regional operations.
1064 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1065 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1066 # this field will contain information on all underlying zonal actions and
1067 # their state.
1068 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1069 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1070 # Example key: zones/us-central1-a
1071 &quot;a_key&quot;: {
1072 &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
1073 # populated.
1074 # different programming environments, including REST APIs and RPC APIs. It is
1075 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1076 # three pieces of data: error code, error message, and error details.
1077 #
1078 # You can find out more about this error model and how to work with it in the
1079 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1080 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1081 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1082 # message types for APIs to use.
1083 {
1084 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1085 },
1086 ],
1087 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1088 # user-facing error message should be localized and sent in the
1089 # google.rpc.Status.details field, or localized by the client.
1090 },
1091 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1092 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1093 },
1094 },
1095 },
1096 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1097 # This value is inRFC3339
1098 # text format.
1099 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1100 # following:
1101 # `PENDING`, `RUNNING`, or `DONE`.
1102 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1103 # operation.
1104 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1105 # of the target resource.
1106 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1107 # operations related to creating a snapshot, this points to the disk
1108 # that the snapshot was created from.
1109 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1110 # `[email protected]` or
1111 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1112 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1113 # operation, this field will be populated.
1114 {
1115 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1116 # Engine returns NO_RESULTS_ON_PAGE if there
1117 # are no results in the response.
1118 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1119 # value format. For example:
1120 #
1121 # &quot;data&quot;: [
1122 # {
1123 # &quot;key&quot;: &quot;scope&quot;,
1124 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1125 # }
1126 {
1127 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1128 # returned. For example, for warnings where there are no results in a list
1129 # request for a particular zone, this key might be scope and
1130 # the key value might be the zone name. Other examples might be a key
1131 # indicating a deprecated resource and a suggested replacement, or a
1132 # warning about invalid network settings (for example, if an instance
1133 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1134 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1135 },
1136 ],
1137 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1138 },
1139 ],
1140 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1141 # applicable when performing per-zone operations.
1142 }</pre>
1143 </div>
1144
1145 <div class="method">
1146 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1147 <pre>Lists the PublicAdvertisedPrefixes for a project.
1148
1149 Args:
1150 project: string, Project ID for this request. (required)
1151 filter: string, A filter expression that filters resources listed in the response. Most
1152 Compute resources support two types of filter expressions:
1153 expressions that support regular expressions and expressions that follow
1154 API improvement proposal AIP-160.
1155 These two types of filter expressions cannot be mixed in one request.
1156
1157 If you want to use AIP-160, your expression must specify the field name, an
1158 operator, and the value that you want to use for filtering. The value
1159 must be a string, a number, or a boolean. The operator
1160 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1161
1162 For example, if you are filtering Compute Engine instances, you can
1163 exclude instances named `example-instance` by specifying
1164 `name != example-instance`.
1165
1166 The `:*` comparison can be used to test whether a key has been defined.
1167 For example, to find all objects with `owner` label use:
1168 ```
1169 labels.owner:*
1170 ```
1171
1172 You can also filter nested fields. For example, you could specify
1173 `scheduling.automaticRestart = false` to include instances only
1174 if they are not scheduled for automatic restarts. You can use filtering
1175 on nested fields to filter based onresource labels.
1176
1177 To filter on multiple expressions, provide each separate expression within
1178 parentheses. For example:
1179 ```
1180 (scheduling.automaticRestart = true)
1181 (cpuPlatform = &quot;Intel Skylake&quot;)
1182 ```
1183 By default, each expression is an `AND` expression. However, you
1184 can include `AND` and `OR` expressions explicitly.
1185 For example:
1186 ```
1187 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1188 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1189 (scheduling.automaticRestart = true)
1190 ```
1191
1192 If you want to use a regular expression, use the `eq` (equal) or `ne`
1193 (not equal) operator against a single un-parenthesized expression with or
1194 without quotes or against multiple parenthesized expressions. Examples:
1195
1196 `fieldname eq unquoted literal`
1197 `fieldname eq &#x27;single quoted literal&#x27;`
1198 `fieldname eq &quot;double quoted literal&quot;`
1199 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1200
1201 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1202 The literal value must match the entire field.
1203
1204 For example, to filter for instances that do not end with name &quot;instance&quot;,
1205 you would use `name ne .*instance`.
1206
1207 You cannot combine constraints on multiple fields using regular
1208 expressions.
1209 maxResults: integer, The maximum number of results per page that should be returned.
1210 If the number of available results is larger than `maxResults`,
1211 Compute Engine returns a `nextPageToken` that can be used to get
1212 the next page of results in subsequent list requests. Acceptable values are
1213 `0` to `500`, inclusive. (Default: `500`)
1214 orderBy: string, Sorts list results by a certain order. By default, results
1215 are returned in alphanumerical order based on the resource name.
1216
1217 You can also sort results in descending order based on the creation
1218 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1219 results based on the `creationTimestamp` field in
1220 reverse chronological order (newest result first). Use this to sort
1221 resources like operations so that the newest operation is returned first.
1222
1223 Currently, only sorting by `name` or
1224 `creationTimestamp desc` is supported.
1225 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1226 `nextPageToken` returned by a previous list request to get
1227 the next page of results.
1228 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1229 of failure. The default value is false.
1230
1231 For example, when partial success behavior is enabled, aggregatedList for a
1232 single zone scope either returns all resources in the zone or no resources,
1233 with an error code.
1234 x__xgafv: string, V1 error format.
1235 Allowed values
1236 1 - v1 error format
1237 2 - v2 error format
1238
1239 Returns:
1240 An object of the form:
1241
1242 {
1243 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1244 &quot;items&quot;: [ # A list of PublicAdvertisedPrefix resources.
1245 { # A public advertised prefix represents an aggregated IP prefix or netblock
1246 # which customers bring to cloud. The IP prefix is a single unit of route
1247 # advertisement and is announced globally to the internet.
1248 &quot;byoipApiVersion&quot;: &quot;A String&quot;, # Output only. [Output Only] The version of BYOIP API.
1249 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1250 # text format.
1251 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1252 # create the resource.
1253 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The address to be used for reverse DNS verification.
1254 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1255 # This field is used in optimistic locking. This field will be ignored when
1256 # inserting a new PublicAdvertisedPrefix. An up-to-date
1257 # fingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with
1258 # error 412 conditionNotMet.
1259 #
1260 # To see the latest fingerprint, make a get() request to
1261 # retrieve a PublicAdvertisedPrefix.
1262 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
1263 # generates this identifier.
1264 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The address range, in CIDR format, represented by this public advertised
1265 # prefix.
1266 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The internet access type for IPv6 Public Advertised Prefixes.
1267 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.
1268 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1269 # The name must be 1-63 characters long, and comply withRFC1035.
1270 # Specifically, the name must be 1-63 characters long and match the regular
1271 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1272 # character must be a lowercase letter, and all following characters must
1273 # be a dash, lowercase letter, or digit, except the last character, which
1274 # cannot be a dash.
1275 &quot;pdpScope&quot;: &quot;A String&quot;, # Specifies how child public delegated prefix will be scoped. It could
1276 # be one of following values:
1277 #
1278 #
1279 # - `REGIONAL`: The public delegated prefix is regional only. The
1280 # provisioning will take a few minutes.
1281 # - `GLOBAL`: The public delegated prefix is global only. The
1282 # provisioning will take ~4 weeks.
1283 # - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
1284 # BYOIP V1 legacy prefix. This is output only value and no longer
1285 # supported in BYOIP V2.
1286 &quot;publicDelegatedPrefixs&quot;: [ # Output only. [Output Only] The list of public delegated prefixes that exist for this
1287 # public advertised prefix.
1288 { # Represents a CIDR range which can be used to assign addresses.
1289 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
1290 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
1291 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
1292 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent,
1293 # the prefix is global.
1294 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are:
1295 # INITIALIZING: The public delegated prefix is being initialized and
1296 # addresses cannot be created yet.
1297 # ANNOUNCED: The public delegated prefix is active.
1298 },
1299 ],
1300 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1301 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
1302 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix. Possible values include:
1303 #
1304 #
1305 # - `INITIAL`: RPKI validation is complete.
1306 # - `PTR_CONFIGURED`: User has configured the PTR.
1307 # - `VALIDATED`: Reverse DNS lookup is successful.
1308 # - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
1309 # - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
1310 # configured.
1311 # - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
1312 # - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
1313 },
1314 ],
1315 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefixList&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.
1316 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1317 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1318 # the query parameter pageToken in the next list request.
1319 # Subsequent list requests will have their own nextPageToken to
1320 # continue paging through the results.
1321 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
1322 &quot;warning&quot;: { # [Output Only] Informational warning message.
1323 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1324 # Engine returns NO_RESULTS_ON_PAGE if there
1325 # are no results in the response.
1326 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1327 # value format. For example:
1328 #
1329 # &quot;data&quot;: [
1330 # {
1331 # &quot;key&quot;: &quot;scope&quot;,
1332 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1333 # }
1334 {
1335 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1336 # returned. For example, for warnings where there are no results in a list
1337 # request for a particular zone, this key might be scope and
1338 # the key value might be the zone name. Other examples might be a key
1339 # indicating a deprecated resource and a suggested replacement, or a
1340 # warning about invalid network settings (for example, if an instance
1341 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1342 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1343 },
1344 ],
1345 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1346 },
1347 }</pre>
1348 </div>
1349
1350 <div class="method">
1351 <code class="details" id="list_next">list_next()</code>
1352 <pre>Retrieves the next page of results.
1353
1354 Args:
1355 previous_request: The request for the previous page. (required)
1356 previous_response: The response from the request for the previous page. (required)
1357
1358 Returns:
1359 A request object that you can call &#x27;execute()&#x27; on to request the next
1360 page. Returns None if there are no more items in the collection.
1361 </pre>
1362 </div>
1363
1364 <div class="method">
1365 <code class="details" id="patch">patch(project, publicAdvertisedPrefix, body=None, requestId=None, x__xgafv=None)</code>
1366 <pre>Patches the specified Router resource with the data included in the
1367 request. This method supportsPATCH
1368 semantics and usesJSON merge
1369 patch format and processing rules.
1370
1371 Args:
1372 project: string, Project ID for this request. (required)
1373 publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to patch. (required)
1374 body: object, The request body.
1375 The object takes the form of:
1376
1377 { # A public advertised prefix represents an aggregated IP prefix or netblock
1378 # which customers bring to cloud. The IP prefix is a single unit of route
1379 # advertisement and is announced globally to the internet.
1380 &quot;byoipApiVersion&quot;: &quot;A String&quot;, # Output only. [Output Only] The version of BYOIP API.
1381 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1382 # text format.
1383 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1384 # create the resource.
1385 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The address to be used for reverse DNS verification.
1386 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1387 # This field is used in optimistic locking. This field will be ignored when
1388 # inserting a new PublicAdvertisedPrefix. An up-to-date
1389 # fingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with
1390 # error 412 conditionNotMet.
1391 #
1392 # To see the latest fingerprint, make a get() request to
1393 # retrieve a PublicAdvertisedPrefix.
1394 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource type. The server
1395 # generates this identifier.
1396 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The address range, in CIDR format, represented by this public advertised
1397 # prefix.
1398 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The internet access type for IPv6 Public Advertised Prefixes.
1399 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.
1400 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1401 # The name must be 1-63 characters long, and comply withRFC1035.
1402 # Specifically, the name must be 1-63 characters long and match the regular
1403 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1404 # character must be a lowercase letter, and all following characters must
1405 # be a dash, lowercase letter, or digit, except the last character, which
1406 # cannot be a dash.
1407 &quot;pdpScope&quot;: &quot;A String&quot;, # Specifies how child public delegated prefix will be scoped. It could
1408 # be one of following values:
1409 #
1410 #
1411 # - `REGIONAL`: The public delegated prefix is regional only. The
1412 # provisioning will take a few minutes.
1413 # - `GLOBAL`: The public delegated prefix is global only. The
1414 # provisioning will take ~4 weeks.
1415 # - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
1416 # BYOIP V1 legacy prefix. This is output only value and no longer
1417 # supported in BYOIP V2.
1418 &quot;publicDelegatedPrefixs&quot;: [ # Output only. [Output Only] The list of public delegated prefixes that exist for this
1419 # public advertised prefix.
1420 { # Represents a CIDR range which can be used to assign addresses.
1421 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
1422 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
1423 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
1424 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent,
1425 # the prefix is global.
1426 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are:
1427 # INITIALIZING: The public delegated prefix is being initialized and
1428 # addresses cannot be created yet.
1429 # ANNOUNCED: The public delegated prefix is active.
1430 },
1431 ],
1432 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1433 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
1434 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix. Possible values include:
1435 #
1436 #
1437 # - `INITIAL`: RPKI validation is complete.
1438 # - `PTR_CONFIGURED`: User has configured the PTR.
1439 # - `VALIDATED`: Reverse DNS lookup is successful.
1440 # - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
1441 # - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
1442 # configured.
1443 # - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
1444 # - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.
1445 }
1446
1447 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1448 that if you must retry your request, the server will know to ignore the
1449 request if it has already been completed.
1450
1451 For example, consider a situation where you make an initial request and
1452 the request times out. If you make the request again with the same
1453 request ID, the server can check if original operation with the same
1454 request ID was received, and if so, will ignore the second request. This
1455 prevents clients from accidentally creating duplicate commitments.
1456
1457 The request ID must be
1458 a valid UUID with the exception that zero UUID is not supported
1459 (00000000-0000-0000-0000-000000000000).
1460 x__xgafv: string, V1 error format.
1461 Allowed values
1462 1 - v1 error format
1463 2 - v2 error format
1464
1465 Returns:
1466 An object of the form:
1467
1468 { # Represents an Operation resource.
1469 #
1470 # Google Compute Engine has three Operation resources:
1471 #
1472 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1473 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1474 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1475 #
1476 # You can use an operation resource to manage asynchronous API requests.
1477 # For more information, readHandling
1478 # API responses.
1479 #
1480 # Operations can be global, regional or zonal.
1481 #
1482 # - For global operations, use the `globalOperations`
1483 # resource.
1484 # - For regional operations, use the
1485 # `regionOperations` resource.
1486 # - For zonal operations, use
1487 # the `zoneOperations` resource.
1488 #
1489 #
1490 #
1491 # For more information, read
1492 # Global, Regional, and Zonal Resources.
1493 #
1494 # Note that completed Operation resources have a limited
1495 # retention period.
1496 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1497 # Not present otherwise.
1498 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1499 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1500 # set when the operation is created.
1501 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1502 # text format.
1503 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1504 # this field will be populated.
1505 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1506 # operation.
1507 {
1508 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1509 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1510 # details. There is a set of defined message types to use for providing
1511 # details.The syntax depends on the error code. For example,
1512 # QuotaExceededInfo will have details when the error code is
1513 # QUOTA_EXCEEDED.
1514 {
1515 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1516 #
1517 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1518 # is not enabled:
1519 #
1520 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1521 # &quot;domain&quot;: &quot;googleapis.com&quot;
1522 # &quot;metadata&quot;: {
1523 # &quot;resource&quot;: &quot;projects/123&quot;,
1524 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1525 # }
1526 # }
1527 #
1528 # This response indicates that the pubsub.googleapis.com API is not enabled.
1529 #
1530 # Example of an error that is returned when attempting to create a Spanner
1531 # instance in a region that is out of stock:
1532 #
1533 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1534 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1535 # &quot;metadata&quot;: {
1536 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1537 # }
1538 # }
1539 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1540 # is typically the registered service name of the tool or product that
1541 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1542 # generated by some common infrastructure, the error domain must be a
1543 # globally unique value that identifies the infrastructure. For Google API
1544 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1545 &quot;metadatas&quot;: { # Additional structured details about this error.
1546 #
1547 # Keys must match a regular expression of `a-z+` but should
1548 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1549 # length. When identifying the current value of an exceeded limit, the units
1550 # should be contained in the key, not the value. For example, rather than
1551 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1552 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1553 # instances that can be created in a single (batch) request.
1554 &quot;a_key&quot;: &quot;A String&quot;,
1555 },
1556 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1557 # proximate cause of the error. Error reasons are unique within a particular
1558 # domain of errors. This should be at most 63 characters and match a
1559 # regular expression of `A-Z+[A-Z0-9]`, which represents
1560 # UPPER_SNAKE_CASE.
1561 },
1562 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1563 #
1564 # For example, if a quota check failed with an error indicating the calling
1565 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1566 # directly to the right place in the developer console to flip the bit.
1567 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1568 { # Describes a URL link.
1569 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1570 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1571 },
1572 ],
1573 },
1574 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1575 # which can be attached to an RPC error.
1576 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1577 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1578 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1579 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1580 },
1581 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1582 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1583 &quot;a_key&quot;: &quot;A String&quot;,
1584 },
1585 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1586 # type or metric.
1587 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1588 # or metric.
1589 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1590 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1591 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1592 },
1593 },
1594 ],
1595 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1596 # This property is optional.
1597 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1598 },
1599 ],
1600 },
1601 &quot;getVersionOperationMetadata&quot;: {
1602 &quot;inlineSbomInfo&quot;: {
1603 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1604 # appropriate identifiers.
1605 &quot;a_key&quot;: &quot;A String&quot;,
1606 },
1607 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1608 # identifiers.
1609 &quot;a_key&quot;: &quot;A String&quot;,
1610 },
1611 },
1612 },
1613 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1614 # message that was returned, such as `NOT FOUND`.
1615 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1616 # status code that was returned. For example, a `404` means the
1617 # resource was not found.
1618 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1619 # defined by the server.
1620 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1621 # This value is inRFC3339
1622 # text format.
1623 &quot;instancesBulkInsertOperationMetadata&quot;: {
1624 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1625 # Example key: zones/us-central1-a
1626 &quot;a_key&quot;: {
1627 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1628 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1629 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1630 # error.
1631 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1632 # if the flow is rolling forward or rolling back.
1633 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1634 },
1635 },
1636 },
1637 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1638 # Operation resources.
1639 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1640 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1641 # group of operations results from a `bulkInsert` API request.
1642 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1643 # `update`, or `delete`, and so on.
1644 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1645 # There is no requirement that this be linear or support any granularity of
1646 # operations. This should not be used to guess when the operation will be
1647 # complete. This number should monotonically increase as the operation
1648 # progresses.
1649 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1650 # applicable when performing regional operations.
1651 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1652 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1653 # this field will contain information on all underlying zonal actions and
1654 # their state.
1655 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1656 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1657 # Example key: zones/us-central1-a
1658 &quot;a_key&quot;: {
1659 &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
1660 # populated.
1661 # different programming environments, including REST APIs and RPC APIs. It is
1662 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1663 # three pieces of data: error code, error message, and error details.
1664 #
1665 # You can find out more about this error model and how to work with it in the
1666 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1667 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1668 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1669 # message types for APIs to use.
1670 {
1671 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1672 },
1673 ],
1674 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1675 # user-facing error message should be localized and sent in the
1676 # google.rpc.Status.details field, or localized by the client.
1677 },
1678 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1679 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1680 },
1681 },
1682 },
1683 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1684 # This value is inRFC3339
1685 # text format.
1686 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1687 # following:
1688 # `PENDING`, `RUNNING`, or `DONE`.
1689 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1690 # operation.
1691 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1692 # of the target resource.
1693 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1694 # operations related to creating a snapshot, this points to the disk
1695 # that the snapshot was created from.
1696 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1697 # `[email protected]` or
1698 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1699 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1700 # operation, this field will be populated.
1701 {
1702 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1703 # Engine returns NO_RESULTS_ON_PAGE if there
1704 # are no results in the response.
1705 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1706 # value format. For example:
1707 #
1708 # &quot;data&quot;: [
1709 # {
1710 # &quot;key&quot;: &quot;scope&quot;,
1711 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1712 # }
1713 {
1714 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1715 # returned. For example, for warnings where there are no results in a list
1716 # request for a particular zone, this key might be scope and
1717 # the key value might be the zone name. Other examples might be a key
1718 # indicating a deprecated resource and a suggested replacement, or a
1719 # warning about invalid network settings (for example, if an instance
1720 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1721 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1722 },
1723 ],
1724 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1725 },
1726 ],
1727 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1728 # applicable when performing per-zone operations.
1729 }</pre>
1730 </div>
1731
1732 <div class="method">
1733 <code class="details" id="withdraw">withdraw(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</code>
1734 <pre>Withdraws the specified PublicAdvertisedPrefix
1735
1736 Args:
1737 project: string, Project ID for this request. (required)
1738 publicAdvertisedPrefix: string, The name of the public advertised prefix. It should comply with RFC1035. (required)
1739 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1740 that if you must retry your request, the server will know to ignore the
1741 request if it has already been completed.
1742
1743 For example, consider a situation where you make an initial request and
1744 the request times out. If you make the request again with the same
1745 request ID, the server can check if original operation with the same
1746 request ID was received, and if so, will ignore the second request. This
1747 prevents clients from accidentally creating duplicate commitments.
1748
1749 The request ID must be
1750 a valid UUID with the exception that zero UUID is not supported
1751 (00000000-0000-0000-0000-000000000000).
1752 x__xgafv: string, V1 error format.
1753 Allowed values
1754 1 - v1 error format
1755 2 - v2 error format
1756
1757 Returns:
1758 An object of the form:
1759
1760 { # Represents an Operation resource.
1761 #
1762 # Google Compute Engine has three Operation resources:
1763 #
1764 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1765 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1766 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1767 #
1768 # You can use an operation resource to manage asynchronous API requests.
1769 # For more information, readHandling
1770 # API responses.
1771 #
1772 # Operations can be global, regional or zonal.
1773 #
1774 # - For global operations, use the `globalOperations`
1775 # resource.
1776 # - For regional operations, use the
1777 # `regionOperations` resource.
1778 # - For zonal operations, use
1779 # the `zoneOperations` resource.
1780 #
1781 #
1782 #
1783 # For more information, read
1784 # Global, Regional, and Zonal Resources.
1785 #
1786 # Note that completed Operation resources have a limited
1787 # retention period.
1788 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1789 # Not present otherwise.
1790 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1791 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1792 # set when the operation is created.
1793 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1794 # text format.
1795 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1796 # this field will be populated.
1797 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1798 # operation.
1799 {
1800 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1801 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1802 # details. There is a set of defined message types to use for providing
1803 # details.The syntax depends on the error code. For example,
1804 # QuotaExceededInfo will have details when the error code is
1805 # QUOTA_EXCEEDED.
1806 {
1807 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1808 #
1809 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1810 # is not enabled:
1811 #
1812 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1813 # &quot;domain&quot;: &quot;googleapis.com&quot;
1814 # &quot;metadata&quot;: {
1815 # &quot;resource&quot;: &quot;projects/123&quot;,
1816 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1817 # }
1818 # }
1819 #
1820 # This response indicates that the pubsub.googleapis.com API is not enabled.
1821 #
1822 # Example of an error that is returned when attempting to create a Spanner
1823 # instance in a region that is out of stock:
1824 #
1825 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1826 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1827 # &quot;metadata&quot;: {
1828 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1829 # }
1830 # }
1831 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1832 # is typically the registered service name of the tool or product that
1833 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1834 # generated by some common infrastructure, the error domain must be a
1835 # globally unique value that identifies the infrastructure. For Google API
1836 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1837 &quot;metadatas&quot;: { # Additional structured details about this error.
1838 #
1839 # Keys must match a regular expression of `a-z+` but should
1840 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1841 # length. When identifying the current value of an exceeded limit, the units
1842 # should be contained in the key, not the value. For example, rather than
1843 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1844 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1845 # instances that can be created in a single (batch) request.
1846 &quot;a_key&quot;: &quot;A String&quot;,
1847 },
1848 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1849 # proximate cause of the error. Error reasons are unique within a particular
1850 # domain of errors. This should be at most 63 characters and match a
1851 # regular expression of `A-Z+[A-Z0-9]`, which represents
1852 # UPPER_SNAKE_CASE.
1853 },
1854 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1855 #
1856 # For example, if a quota check failed with an error indicating the calling
1857 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1858 # directly to the right place in the developer console to flip the bit.
1859 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1860 { # Describes a URL link.
1861 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1862 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1863 },
1864 ],
1865 },
1866 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1867 # which can be attached to an RPC error.
1868 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1869 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1870 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1871 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1872 },
1873 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1874 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1875 &quot;a_key&quot;: &quot;A String&quot;,
1876 },
1877 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1878 # type or metric.
1879 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1880 # or metric.
1881 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1882 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1883 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1884 },
1885 },
1886 ],
1887 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1888 # This property is optional.
1889 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1890 },
1891 ],
1892 },
1893 &quot;getVersionOperationMetadata&quot;: {
1894 &quot;inlineSbomInfo&quot;: {
1895 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1896 # appropriate identifiers.
1897 &quot;a_key&quot;: &quot;A String&quot;,
1898 },
1899 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1900 # identifiers.
1901 &quot;a_key&quot;: &quot;A String&quot;,
1902 },
1903 },
1904 },
1905 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1906 # message that was returned, such as `NOT FOUND`.
1907 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1908 # status code that was returned. For example, a `404` means the
1909 # resource was not found.
1910 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1911 # defined by the server.
1912 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1913 # This value is inRFC3339
1914 # text format.
1915 &quot;instancesBulkInsertOperationMetadata&quot;: {
1916 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1917 # Example key: zones/us-central1-a
1918 &quot;a_key&quot;: {
1919 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1920 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1921 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1922 # error.
1923 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1924 # if the flow is rolling forward or rolling back.
1925 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1926 },
1927 },
1928 },
1929 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1930 # Operation resources.
1931 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1932 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1933 # group of operations results from a `bulkInsert` API request.
1934 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1935 # `update`, or `delete`, and so on.
1936 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1937 # There is no requirement that this be linear or support any granularity of
1938 # operations. This should not be used to guess when the operation will be
1939 # complete. This number should monotonically increase as the operation
1940 # progresses.
1941 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1942 # applicable when performing regional operations.
1943 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1944 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1945 # this field will contain information on all underlying zonal actions and
1946 # their state.
1947 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1948 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1949 # Example key: zones/us-central1-a
1950 &quot;a_key&quot;: {
1951 &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
1952 # populated.
1953 # different programming environments, including REST APIs and RPC APIs. It is
1954 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1955 # three pieces of data: error code, error message, and error details.
1956 #
1957 # You can find out more about this error model and how to work with it in the
1958 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1959 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1960 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1961 # message types for APIs to use.
1962 {
1963 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1964 },
1965 ],
1966 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1967 # user-facing error message should be localized and sent in the
1968 # google.rpc.Status.details field, or localized by the client.
1969 },
1970 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1971 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1972 },
1973 },
1974 },
1975 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1976 # This value is inRFC3339
1977 # text format.
1978 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1979 # following:
1980 # `PENDING`, `RUNNING`, or `DONE`.
1981 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1982 # operation.
1983 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1984 # of the target resource.
1985 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1986 # operations related to creating a snapshot, this points to the disk
1987 # that the snapshot was created from.
1988 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1989 # `[email protected]` or
1990 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1991 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1992 # operation, this field will be populated.
1993 {
1994 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1995 # Engine returns NO_RESULTS_ON_PAGE if there
1996 # are no results in the response.
1997 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1998 # value format. For example:
1999 #
2000 # &quot;data&quot;: [
2001 # {
2002 # &quot;key&quot;: &quot;scope&quot;,
2003 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2004 # }
2005 {
2006 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2007 # returned. For example, for warnings where there are no results in a list
2008 # request for a particular zone, this key might be scope and
2009 # the key value might be the zone name. Other examples might be a key
2010 # indicating a deprecated resource and a suggested replacement, or a
2011 # warning about invalid network settings (for example, if an instance
2012 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2013 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2014 },
2015 ],
2016 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2017 },
2018 ],
2019 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2020 # applicable when performing per-zone operations.
2021 }</pre>
2022 </div>
2023
2024 </body></html>