Debian Codegraph @

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