Debian Codegraph @

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