Debian Codegraph @

docs/dyn/compute_beta.addresses.html

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