Debian Codegraph @

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