Debian Codegraph @

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