Debian Codegraph @

docs/dyn/compute_v1.forwardingRules.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.forwardingRules.html">forwardingRules</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves an aggregated list of forwarding rules.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, forwardingRule, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified ForwardingRule resource.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, region, forwardingRule, view=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified ForwardingRule resource.</p>
92 <p class="toc_element">
93 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Creates a ForwardingRule resource in the specified project and region using</p>
95 <p class="toc_element">
96 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Retrieves a list of ForwardingRule resources available to the specified</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#patch">patch(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates the specified forwarding rule with the data included in the</p>
104 <p class="toc_element">
105 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Sets the labels on the specified resource. To learn more about labels,</p>
107 <p class="toc_element">
108 <code><a href="#setTarget">setTarget(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Changes target URL for forwarding rule. The new target should be of the</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
113 <pre>Retrieves an aggregated list of forwarding rules.
114
115 To prevent failure, it is recommended that you set the
116 `returnPartialSuccess` parameter to `true`.
117
118 Args:
119 project: string, Project ID for this request. (required)
120 filter: string, A filter expression that filters resources listed in the response. Most
121 Compute resources support two types of filter expressions:
122 expressions that support regular expressions and expressions that follow
123 API improvement proposal AIP-160.
124 These two types of filter expressions cannot be mixed in one request.
125
126 If you want to use AIP-160, your expression must specify the field name, an
127 operator, and the value that you want to use for filtering. The value
128 must be a string, a number, or a boolean. The operator
129 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
130
131 For example, if you are filtering Compute Engine instances, you can
132 exclude instances named `example-instance` by specifying
133 `name != example-instance`.
134
135 The `:*` comparison can be used to test whether a key has been defined.
136 For example, to find all objects with `owner` label use:
137 ```
138 labels.owner:*
139 ```
140
141 You can also filter nested fields. For example, you could specify
142 `scheduling.automaticRestart = false` to include instances only
143 if they are not scheduled for automatic restarts. You can use filtering
144 on nested fields to filter based onresource labels.
145
146 To filter on multiple expressions, provide each separate expression within
147 parentheses. For example:
148 ```
149 (scheduling.automaticRestart = true)
150 (cpuPlatform = &quot;Intel Skylake&quot;)
151 ```
152 By default, each expression is an `AND` expression. However, you
153 can include `AND` and `OR` expressions explicitly.
154 For example:
155 ```
156 (cpuPlatform = &quot;Intel Skylake&quot;) OR
157 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
158 (scheduling.automaticRestart = true)
159 ```
160
161 If you want to use a regular expression, use the `eq` (equal) or `ne`
162 (not equal) operator against a single un-parenthesized expression with or
163 without quotes or against multiple parenthesized expressions. Examples:
164
165 `fieldname eq unquoted literal`
166 `fieldname eq &#x27;single quoted literal&#x27;`
167 `fieldname eq &quot;double quoted literal&quot;`
168 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
169
170 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
171 The literal value must match the entire field.
172
173 For example, to filter for instances that do not end with name &quot;instance&quot;,
174 you would use `name ne .*instance`.
175
176 You cannot combine constraints on multiple fields using regular
177 expressions.
178 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
179 global) should be included in the response. For new resource types added
180 after this field, the flag has no effect as new resource types will always
181 include every visible scope for each scope type in response. For resource
182 types which predate this field, if this flag is omitted or false, only
183 scopes of the scope types where the resource type is expected to be found
184 will be included.
185 maxResults: integer, The maximum number of results per page that should be returned.
186 If the number of available results is larger than `maxResults`,
187 Compute Engine returns a `nextPageToken` that can be used to get
188 the next page of results in subsequent list requests. Acceptable values are
189 `0` to `500`, inclusive. (Default: `500`)
190 orderBy: string, Sorts list results by a certain order. By default, results
191 are returned in alphanumerical order based on the resource name.
192
193 You can also sort results in descending order based on the creation
194 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
195 results based on the `creationTimestamp` field in
196 reverse chronological order (newest result first). Use this to sort
197 resources like operations so that the newest operation is returned first.
198
199 Currently, only sorting by `name` or
200 `creationTimestamp desc` is supported.
201 pageToken: string, Specifies a page token to use. Set `pageToken` to the
202 `nextPageToken` returned by a previous list request to get
203 the next page of results.
204 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
205 of failure. The default value is false.
206
207 For example, when partial success behavior is enabled, aggregatedList for a
208 single zone scope either returns all resources in the zone or no resources,
209 with an error code.
210 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
211 aggregated list request is invoked for subnetworks list-usable api.
212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217 Returns:
218 An object of the form:
219
220 {
221 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
222 &quot;items&quot;: { # A list of ForwardingRulesScopedList resources.
223 &quot;a_key&quot;: { # Name of the scope containing this set of addresses.
224 &quot;forwardingRules&quot;: [ # A list of forwarding rules contained in this scope.
225 { # Represents a Forwarding Rule resource.
226 #
227 # Forwarding rule resources in Google Cloud can be either regional or global in
228 # scope:
229 #
230 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
231 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
232 #
233 # A forwarding rule and its corresponding IP address represent the frontend
234 # configuration of a Google Cloud load balancer.
235 # Forwarding rules can also reference target instances and Cloud VPN Classic
236 # gateways (targetVpnGateway).
237 #
238 # For more information, read
239 # Forwarding rule concepts and
240 # Using protocol forwarding.
241 &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
242 # sends traffic to this IP address, the forwarding rule directs the traffic
243 # to the referenced target or backendService.
244 # While creating a forwarding rule, specifying an IPAddress is
245 # required under the following circumstances:
246 #
247 #
248 # - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
249 # - When the target is a Private Service Connect Google APIs
250 # bundle, you must specify an IPAddress.
251 #
252 #
253 # Otherwise, you can optionally specify an IP address that references an
254 # existing static (reserved) IP address resource. When omitted, Google Cloud
255 # assigns an ephemeral IP address.
256 #
257 # Use one of the following formats to specify an IP address while creating a
258 # forwarding rule:
259 #
260 # * IP address number, as in `100.1.2.3`
261 # * IPv6 address range, as in `2600:1234::/96`
262 # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
263 # * Partial URL or by name, as in:
264 #
265 # - projects/project_id/regions/region/addresses/address-name
266 # - regions/region/addresses/address-name
267 # - global/addresses/address-name
268 # - address-name
269 #
270 #
271 #
272 # The forwarding rule&#x27;s target or backendService,
273 # and in most cases, also the loadBalancingScheme, determine the
274 # type of IP address that you can use. For detailed information, see
275 # [IP address
276 # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
277 #
278 # When reading an IPAddress, the API always returns the IP
279 # address number.
280 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
281 #
282 # For protocol forwarding, valid
283 # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
284 #
285 # The valid IP protocols are different for different load balancing products
286 # as described in [Load balancing
287 # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
288 &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
289 # fields are mutually exclusive. Only packets addressed to ports in the
290 # specified range will be forwarded to the backends configured with this
291 # forwarding rule.
292 #
293 # The allPorts field has the following limitations:
294 #
295 # - It requires that the forwarding rule IPProtocol be TCP,
296 # UDP, SCTP, or L3_DEFAULT.
297 # - It&#x27;s applicable only to the following products: internal passthrough
298 # Network Load Balancers, backend service-based external passthrough Network
299 # Load Balancers, and internal and external protocol forwarding.
300 # - Set this field to true to allow packets addressed to any port or
301 # packets lacking destination port information (for example, UDP fragments
302 # after the first fragment) to be forwarded to the backends configured with
303 # this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
304 &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
305 # Balancers, the regional internal Application Load Balancer, and the
306 # regional internal proxy Network Load Balancer from all regions.
307 # If false, only allows access from the local region the load balancer is
308 # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
309 # cannot be changed after the forwarding rule is created.
310 &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
311 # endpoint can be accessed from another region.
312 &quot;attachedExtensions&quot;: [ # Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
313 { # Reference to an extension resource that is attached to this ForwardingRule.
314 &quot;reference&quot;: &quot;A String&quot;, # Output only. The resource name.
315 },
316 ],
317 &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
318 # Required for internal and external passthrough Network Load Balancers;
319 # must be omitted for all other load balancer types.
320 &quot;baseForwardingRule&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the corresponding base forwarding rule. By base
321 # forwarding rule, we mean the forwarding rule that has the same IP address,
322 # protocol, and port settings with the current forwarding rule, but without
323 # sourceIPRanges specified.
324 # Always empty if the current forwarding rule does not have sourceIPRanges
325 # specified.
326 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
327 # text format.
328 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
329 # create the resource.
330 &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
331 # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
332 # TEST_ALL_TRAFFIC.
333 #
334 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
335 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
336 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
337 # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
338 # attached to this forwarding rule by percentage using
339 # externalManagedBackendBucketMigrationTestingPercentage.
340 #
341 # Rolling back a migration requires the states to be set in reverse order. So
342 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
343 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
344 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
345 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
346 &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
347 # processed by the global external Application Load Balancer.
348 #
349 # The value of this field must be in the range [0, 100].
350 #
351 # This value can only be set if the loadBalancingScheme in the BackendService
352 # is set to EXTERNAL (when using the classic Application Load Balancer) and
353 # the migration state is TEST_BY_PERCENTAGE.
354 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
355 # This field is used in optimistic locking. This field will be ignored when
356 # inserting a ForwardingRule. Include the fingerprint in patch request to
357 # ensure that you do not overwrite changes that were applied from another
358 # concurrent request.
359 #
360 # To see the latest fingerprint, make a get() request to
361 # retrieve a ForwardingRule.
362 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
363 # defined by the server.
364 &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
365 # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
366 #
367 # Use one of the following formats to specify a sub-PDP when creating an IPv6
368 # NetLB forwarding rule using BYOIP:
369 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
370 # Partial URL, as in:
371 #
372 # - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
373 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
374 &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule. Valid options
375 # are IPV4 or IPV6.
376 &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
377 # packet mirroring. To prevent mirroring loops, instances behind this
378 # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
379 # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
380 &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
381 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
382 # essentially a hash of the labels set used for optimistic locking. The
383 # fingerprint is initially generated by Compute Engine and changes after
384 # every request to modify or update labels. You must always provide an
385 # up-to-date fingerprint hash in order to update or change labels,
386 # otherwise the request will fail with error412 conditionNotMet.
387 #
388 # To see the latest fingerprint, make a get() request to
389 # retrieve a ForwardingRule.
390 &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.
391 # Label values may be empty.
392 &quot;a_key&quot;: &quot;A String&quot;,
393 },
394 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
395 #
396 # For more information about forwarding rules, refer to
397 # Forwarding rule concepts.
398 &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
399 # configuration to a limited set of xDS
400 # compliant clients. In their xDS requests to load balancer, xDS clients
401 # present node
402 # metadata. When there is a match, the relevant configuration
403 # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
404 # referenced by the ForwardingRule are not visible to
405 # those proxies.
406 #
407 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
408 # the metadata. If its filterMatchCriteria is set to
409 # MATCH_ALL, then all of its filterLabels must match with
410 # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
411 # in order to be considered a match.
412 #
413 # metadataFilters specified here will be applifed before
414 # those specified in the UrlMap that thisForwardingRule references.
415 #
416 # metadataFilters only applies to Loadbalancers that have
417 # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
418 { # Opaque filter criteria used by load balancers to restrict routing
419 # configuration to a limited set of load balancing proxies. Proxies and
420 # sidecars involved in load balancing would typically present metadata to the
421 # load balancers that need to match criteria specified here. If a match takes
422 # place, the relevant configuration is made available to those
423 # proxies.
424 #
425 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
426 # one of thefilterLabels must match the corresponding label provided in
427 # the metadata. If its filterMatchCriteria is set to
428 # MATCH_ALL, then all of its filterLabels must match with
429 # corresponding labels provided in the metadata.
430 #
431 # An example for using metadataFilters would be: if
432 # load balancing involves
433 # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in of their XDS requests to loadbalancers.
434 &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
435 # metadata based on filterMatchCriteria
436 #
437 # This list must not be empty and can have at the most 64 entries.
438 { # MetadataFilter label name value pairs that are expected
439 # to match corresponding labels presented as metadata to the load balancer.
440 &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
441 #
442 # The name can have a maximum length of 1024 characters and must be at
443 # least 1 character long.
444 &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
445 #
446 # value can have a maximum length of 1024 characters.
447 },
448 ],
449 &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
450 # within the list of filterLabels and contributes toward the
451 # overall metadataFilter match.
452 #
453 # Supported values are:
454 #
455 # - MATCH_ANY: at least one of the filterLabels
456 # must have a matching label in the provided metadata.
457 # - MATCH_ALL: all filterLabels must have
458 # matching labels in the provided metadata.
459 },
460 ],
461 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
462 # The name must be 1-63 characters long, and comply withRFC1035.
463 # Specifically, the name must be 1-63 characters long and match the regular
464 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
465 # character must be a lowercase letter, and all following characters must
466 # be a dash, lowercase letter, or digit, except the last character, which
467 # cannot be a dash.
468 #
469 # For Private Service Connect forwarding rules that forward traffic to Google
470 # APIs, the forwarding rule name must be a 1-20 characters string with
471 # lowercase letters and numbers and must start with a letter.
472 &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
473 #
474 # For internal passthrough Network Load Balancers, this field identifies the
475 # network that the load balanced IP should belong to for this forwarding
476 # rule.
477 # If the subnetwork is specified, the network of the subnetwork will be used.
478 # If neither subnetwork nor this field is specified, the default network will
479 # be used.
480 #
481 # For Private Service Connect forwarding rules that forward traffic to Google
482 # APIs, a network must be provided.
483 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
484 # this load balancer and can only take the following values:PREMIUM, STANDARD.
485 #
486 # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
487 #
488 # If this field is not specified, it is assumed to be PREMIUM.
489 # If IPAddress is specified, this value must be equal to the
490 # networkTier of the Address.
491 &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
492 # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
493 # this field. Once set, this field is not mutable.
494 &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
495 # fields are mutually exclusive. Only packets addressed to ports in the
496 # specified range will be forwarded to the backends configured with this
497 # forwarding rule.
498 #
499 # The portRange field has the following limitations:
500 #
501 # - It requires that the forwarding rule IPProtocol be TCP,
502 # UDP, or SCTP, and
503 # - It&#x27;s applicable only to the following products: external passthrough
504 # Network Load Balancers, internal and external proxy Network Load Balancers,
505 # internal and external Application Load Balancers, external protocol
506 # forwarding, and Classic VPN.
507 # - Some products have restrictions on what ports can be used. See
508 # port specifications for details.
509 #
510 #
511 #
512 # For external forwarding rules, two or more forwarding rules cannot use the
513 # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
514 #
515 # For internal forwarding rules within the same VPC network, two or more
516 # forwarding rules cannot use the same [IPAddress, IPProtocol]
517 # pair, and cannot have overlapping portRanges.
518 #
519 # @pattern: \\d+(?:-\\d+)?
520 &quot;ports&quot;: [ # The ports, portRange, and allPorts
521 # fields are mutually exclusive. Only packets addressed to ports in the
522 # specified range will be forwarded to the backends configured with this
523 # forwarding rule.
524 #
525 # The ports field has the following limitations:
526 #
527 # - It requires that the forwarding rule IPProtocol be TCP,
528 # UDP, or SCTP, and
529 # - It&#x27;s applicable only to the following products: internal passthrough
530 # Network Load Balancers, backend service-based external passthrough Network
531 # Load Balancers, and internal protocol forwarding.
532 # - You can specify a list of up to five ports by number, separated by
533 # commas. The ports can be contiguous or discontiguous.
534 #
535 #
536 #
537 # For external forwarding rules, two or more forwarding rules cannot use the
538 # same [IPAddress, IPProtocol] pair if they share at least one
539 # port number.
540 #
541 # For internal forwarding rules within the same VPC network, two or more
542 # forwarding rules cannot use the same [IPAddress, IPProtocol]
543 # pair if they share at least one port number.
544 #
545 # @pattern: \\d+(?:-\\d+)?
546 &quot;A String&quot;,
547 ],
548 &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
549 &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
550 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional forwarding rule resides.
551 # This field is not applicable to global forwarding rules.
552 # You must specify this field as part of the HTTP request URL. It is
553 # not settable as a field in the request body.
554 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
555 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
556 &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
557 # Currently, only supports a single Service Directory resource.
558 { # Describes the auto-registration of the forwarding rule to Service Directory.
559 # The region and project of the Service Directory resource generated from
560 # this registration will be the same as this forwarding rule.
561 &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
562 &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
563 &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
564 # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
565 # All PSC for Google APIs forwarding rules on the same network should use
566 # the same Service Directory region.
567 },
568 ],
569 &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
570 # If specified, the prefix is the first label of the fully qualified service
571 # name.
572 #
573 # The label must be 1-63 characters long, and comply withRFC1035.
574 # Specifically, the label must be 1-63 characters long and match the regular
575 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
576 # character must be a lowercase letter, and all following characters must
577 # be a dash, lowercase letter, or digit, except the last character, which
578 # cannot be a dash.
579 #
580 # This field is only used for internal load balancing.
581 &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
582 # The internal fully qualified service name for this forwarding rule.
583 #
584 # This field is only used for internal load balancing.
585 &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
586 # source IP address matches one of the IP addresses or CIDR ranges set here.
587 # Note that a forwarding rule can only have up to 64 source IP ranges, and
588 # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
589 # Each source_ip_range entry should be either an IP address (for
590 # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
591 &quot;A String&quot;,
592 ],
593 &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
594 # belong to for this forwarding rule, used with internal load balancers and
595 # external passthrough Network Load Balancers with IPv6.
596 #
597 # If the network specified is in auto subnet mode, this field is optional.
598 # However, a subnetwork must be specified if the network is in custom subnet
599 # mode or when creating external forwarding rule with IPv6.
600 &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic. For
601 # regional forwarding rules, this target must be in the same region as the
602 # forwarding rule. For global forwarding rules, this target must be a global
603 # load balancing resource.
604 #
605 # The forwarded traffic must be of a type appropriate to the target object.
606 #
607 #
608 # - For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
609 # - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
610 #
611 #
612 # - vpc-sc - APIs that support VPC Service Controls.
613 # - all-apis - All supported Google APIs.
614 #
615 #
616 # - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
617 },
618 ],
619 &quot;warning&quot;: { # Informational warning which replaces the list of forwarding rules when
620 # the list is empty.
621 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
622 # Engine returns NO_RESULTS_ON_PAGE if there
623 # are no results in the response.
624 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
625 # value format. For example:
626 #
627 # &quot;data&quot;: [
628 # {
629 # &quot;key&quot;: &quot;scope&quot;,
630 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
631 # }
632 {
633 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
634 # returned. For example, for warnings where there are no results in a list
635 # request for a particular zone, this key might be scope and
636 # the key value might be the zone name. Other examples might be a key
637 # indicating a deprecated resource and a suggested replacement, or a
638 # warning about invalid network settings (for example, if an instance
639 # attempts to perform IP forwarding but is not enabled for IP forwarding).
640 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
641 },
642 ],
643 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
644 },
645 },
646 },
647 &quot;kind&quot;: &quot;compute#forwardingRuleAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#forwardingRuleAggregatedList for lists of forwarding rules.
648 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
649 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
650 # the query parameter pageToken in the next list request.
651 # Subsequent list requests will have their own nextPageToken to
652 # continue paging through the results.
653 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
654 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
655 &quot;A String&quot;,
656 ],
657 &quot;warning&quot;: { # [Output Only] Informational warning message.
658 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
659 # Engine returns NO_RESULTS_ON_PAGE if there
660 # are no results in the response.
661 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
662 # value format. For example:
663 #
664 # &quot;data&quot;: [
665 # {
666 # &quot;key&quot;: &quot;scope&quot;,
667 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
668 # }
669 {
670 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
671 # returned. For example, for warnings where there are no results in a list
672 # request for a particular zone, this key might be scope and
673 # the key value might be the zone name. Other examples might be a key
674 # indicating a deprecated resource and a suggested replacement, or a
675 # warning about invalid network settings (for example, if an instance
676 # attempts to perform IP forwarding but is not enabled for IP forwarding).
677 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
678 },
679 ],
680 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
681 },
682 }</pre>
683 </div>
684
685 <div class="method">
686 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
687 <pre>Retrieves the next page of results.
688
689 Args:
690 previous_request: The request for the previous page. (required)
691 previous_response: The response from the request for the previous page. (required)
692
693 Returns:
694 A request object that you can call &#x27;execute()&#x27; on to request the next
695 page. Returns None if there are no more items in the collection.
696 </pre>
697 </div>
698
699 <div class="method">
700 <code class="details" id="close">close()</code>
701 <pre>Close httplib2 connections.</pre>
702 </div>
703
704 <div class="method">
705 <code class="details" id="delete">delete(project, region, forwardingRule, requestId=None, x__xgafv=None)</code>
706 <pre>Deletes the specified ForwardingRule resource.
707
708 Args:
709 project: string, Project ID for this request. (required)
710 region: string, Name of the region scoping this request. (required)
711 forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
712 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
713 that if you must retry your request, the server will know to ignore the
714 request if it has already been completed.
715
716 For example, consider a situation where you make an initial request and
717 the request times out. If you make the request again with the same
718 request ID, the server can check if original operation with the same
719 request ID was received, and if so, will ignore the second request. This
720 prevents clients from accidentally creating duplicate commitments.
721
722 The request ID must be
723 a valid UUID with the exception that zero UUID is not supported
724 (00000000-0000-0000-0000-000000000000).
725 x__xgafv: string, V1 error format.
726 Allowed values
727 1 - v1 error format
728 2 - v2 error format
729
730 Returns:
731 An object of the form:
732
733 { # Represents an Operation resource.
734 #
735 # Google Compute Engine has three Operation resources:
736 #
737 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
738 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
739 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
740 #
741 # You can use an operation resource to manage asynchronous API requests.
742 # For more information, readHandling
743 # API responses.
744 #
745 # Operations can be global, regional or zonal.
746 #
747 # - For global operations, use the `globalOperations`
748 # resource.
749 # - For regional operations, use the
750 # `regionOperations` resource.
751 # - For zonal operations, use
752 # the `zoneOperations` resource.
753 #
754 #
755 #
756 # For more information, read
757 # Global, Regional, and Zonal Resources.
758 #
759 # Note that completed Operation resources have a limited
760 # retention period.
761 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
762 # Not present otherwise.
763 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
764 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
765 # set when the operation is created.
766 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
767 # text format.
768 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
769 # this field will be populated.
770 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
771 # operation.
772 {
773 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
774 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
775 # details. There is a set of defined message types to use for providing
776 # details.The syntax depends on the error code. For example,
777 # QuotaExceededInfo will have details when the error code is
778 # QUOTA_EXCEEDED.
779 {
780 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
781 #
782 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
783 # is not enabled:
784 #
785 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
786 # &quot;domain&quot;: &quot;googleapis.com&quot;
787 # &quot;metadata&quot;: {
788 # &quot;resource&quot;: &quot;projects/123&quot;,
789 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
790 # }
791 # }
792 #
793 # This response indicates that the pubsub.googleapis.com API is not enabled.
794 #
795 # Example of an error that is returned when attempting to create a Spanner
796 # instance in a region that is out of stock:
797 #
798 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
799 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
800 # &quot;metadata&quot;: {
801 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
802 # }
803 # }
804 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
805 # is typically the registered service name of the tool or product that
806 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
807 # generated by some common infrastructure, the error domain must be a
808 # globally unique value that identifies the infrastructure. For Google API
809 # infrastructure, the error domain is &quot;googleapis.com&quot;.
810 &quot;metadatas&quot;: { # Additional structured details about this error.
811 #
812 # Keys must match a regular expression of `a-z+` but should
813 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
814 # length. When identifying the current value of an exceeded limit, the units
815 # should be contained in the key, not the value. For example, rather than
816 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
817 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
818 # instances that can be created in a single (batch) request.
819 &quot;a_key&quot;: &quot;A String&quot;,
820 },
821 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
822 # proximate cause of the error. Error reasons are unique within a particular
823 # domain of errors. This should be at most 63 characters and match a
824 # regular expression of `A-Z+[A-Z0-9]`, which represents
825 # UPPER_SNAKE_CASE.
826 },
827 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
828 #
829 # For example, if a quota check failed with an error indicating the calling
830 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
831 # directly to the right place in the developer console to flip the bit.
832 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
833 { # Describes a URL link.
834 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
835 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
836 },
837 ],
838 },
839 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
840 # which can be attached to an RPC error.
841 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
842 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
843 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
844 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
845 },
846 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
847 &quot;dimensions&quot;: { # The map holding related quota dimensions.
848 &quot;a_key&quot;: &quot;A String&quot;,
849 },
850 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
851 # type or metric.
852 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
853 # or metric.
854 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
855 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
856 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
857 },
858 },
859 ],
860 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
861 # This property is optional.
862 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
863 },
864 ],
865 },
866 &quot;getVersionOperationMetadata&quot;: {
867 &quot;inlineSbomInfo&quot;: {
868 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
869 # appropriate identifiers.
870 &quot;a_key&quot;: &quot;A String&quot;,
871 },
872 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
873 # identifiers.
874 &quot;a_key&quot;: &quot;A String&quot;,
875 },
876 },
877 },
878 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
879 # message that was returned, such as `NOT FOUND`.
880 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
881 # status code that was returned. For example, a `404` means the
882 # resource was not found.
883 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
884 # defined by the server.
885 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
886 # This value is inRFC3339
887 # text format.
888 &quot;instancesBulkInsertOperationMetadata&quot;: {
889 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
890 # Example key: zones/us-central1-a
891 &quot;a_key&quot;: {
892 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
893 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
894 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
895 # error.
896 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
897 # if the flow is rolling forward or rolling back.
898 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
899 },
900 },
901 },
902 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
903 # Operation resources.
904 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
905 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
906 # group of operations results from a `bulkInsert` API request.
907 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
908 # `update`, or `delete`, and so on.
909 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
910 # There is no requirement that this be linear or support any granularity of
911 # operations. This should not be used to guess when the operation will be
912 # complete. This number should monotonically increase as the operation
913 # progresses.
914 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
915 # applicable when performing regional operations.
916 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
917 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
918 # this field will contain information on all underlying zonal actions and
919 # their state.
920 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
921 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
922 # Example key: zones/us-central1-a
923 &quot;a_key&quot;: {
924 &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
925 # populated.
926 # different programming environments, including REST APIs and RPC APIs. It is
927 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
928 # three pieces of data: error code, error message, and error details.
929 #
930 # You can find out more about this error model and how to work with it in the
931 # [API Design Guide](https://cloud.google.com/apis/design/errors).
932 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
933 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
934 # message types for APIs to use.
935 {
936 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
937 },
938 ],
939 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
940 # user-facing error message should be localized and sent in the
941 # google.rpc.Status.details field, or localized by the client.
942 },
943 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
944 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
945 },
946 },
947 },
948 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
949 # This value is inRFC3339
950 # text format.
951 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
952 # following:
953 # `PENDING`, `RUNNING`, or `DONE`.
954 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
955 # operation.
956 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
957 # of the target resource.
958 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
959 # operations related to creating a snapshot, this points to the disk
960 # that the snapshot was created from.
961 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
962 # `[email protected]` or
963 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
964 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
965 # operation, this field will be populated.
966 {
967 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
968 # Engine returns NO_RESULTS_ON_PAGE if there
969 # are no results in the response.
970 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
971 # value format. For example:
972 #
973 # &quot;data&quot;: [
974 # {
975 # &quot;key&quot;: &quot;scope&quot;,
976 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
977 # }
978 {
979 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
980 # returned. For example, for warnings where there are no results in a list
981 # request for a particular zone, this key might be scope and
982 # the key value might be the zone name. Other examples might be a key
983 # indicating a deprecated resource and a suggested replacement, or a
984 # warning about invalid network settings (for example, if an instance
985 # attempts to perform IP forwarding but is not enabled for IP forwarding).
986 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
987 },
988 ],
989 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
990 },
991 ],
992 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
993 # applicable when performing per-zone operations.
994 }</pre>
995 </div>
996
997 <div class="method">
998 <code class="details" id="get">get(project, region, forwardingRule, view=None, x__xgafv=None)</code>
999 <pre>Returns the specified ForwardingRule resource.
1000
1001 Args:
1002 project: string, Project ID for this request. (required)
1003 region: string, Name of the region scoping this request. (required)
1004 forwardingRule: string, Name of the ForwardingRule resource to return. (required)
1005 view: string, A parameter
1006 Allowed values
1007 BASIC - The default view of a ForwardingRule, which includes the basic fields.
1008 FULL - The full view, including the ForwardingRule.`attached_extensions` field.
1009 x__xgafv: string, V1 error format.
1010 Allowed values
1011 1 - v1 error format
1012 2 - v2 error format
1013
1014 Returns:
1015 An object of the form:
1016
1017 { # Represents a Forwarding Rule resource.
1018 #
1019 # Forwarding rule resources in Google Cloud can be either regional or global in
1020 # scope:
1021 #
1022 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
1023 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
1024 #
1025 # A forwarding rule and its corresponding IP address represent the frontend
1026 # configuration of a Google Cloud load balancer.
1027 # Forwarding rules can also reference target instances and Cloud VPN Classic
1028 # gateways (targetVpnGateway).
1029 #
1030 # For more information, read
1031 # Forwarding rule concepts and
1032 # Using protocol forwarding.
1033 &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
1034 # sends traffic to this IP address, the forwarding rule directs the traffic
1035 # to the referenced target or backendService.
1036 # While creating a forwarding rule, specifying an IPAddress is
1037 # required under the following circumstances:
1038 #
1039 #
1040 # - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
1041 # - When the target is a Private Service Connect Google APIs
1042 # bundle, you must specify an IPAddress.
1043 #
1044 #
1045 # Otherwise, you can optionally specify an IP address that references an
1046 # existing static (reserved) IP address resource. When omitted, Google Cloud
1047 # assigns an ephemeral IP address.
1048 #
1049 # Use one of the following formats to specify an IP address while creating a
1050 # forwarding rule:
1051 #
1052 # * IP address number, as in `100.1.2.3`
1053 # * IPv6 address range, as in `2600:1234::/96`
1054 # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
1055 # * Partial URL or by name, as in:
1056 #
1057 # - projects/project_id/regions/region/addresses/address-name
1058 # - regions/region/addresses/address-name
1059 # - global/addresses/address-name
1060 # - address-name
1061 #
1062 #
1063 #
1064 # The forwarding rule&#x27;s target or backendService,
1065 # and in most cases, also the loadBalancingScheme, determine the
1066 # type of IP address that you can use. For detailed information, see
1067 # [IP address
1068 # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
1069 #
1070 # When reading an IPAddress, the API always returns the IP
1071 # address number.
1072 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
1073 #
1074 # For protocol forwarding, valid
1075 # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
1076 #
1077 # The valid IP protocols are different for different load balancing products
1078 # as described in [Load balancing
1079 # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
1080 &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
1081 # fields are mutually exclusive. Only packets addressed to ports in the
1082 # specified range will be forwarded to the backends configured with this
1083 # forwarding rule.
1084 #
1085 # The allPorts field has the following limitations:
1086 #
1087 # - It requires that the forwarding rule IPProtocol be TCP,
1088 # UDP, SCTP, or L3_DEFAULT.
1089 # - It&#x27;s applicable only to the following products: internal passthrough
1090 # Network Load Balancers, backend service-based external passthrough Network
1091 # Load Balancers, and internal and external protocol forwarding.
1092 # - Set this field to true to allow packets addressed to any port or
1093 # packets lacking destination port information (for example, UDP fragments
1094 # after the first fragment) to be forwarded to the backends configured with
1095 # this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
1096 &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
1097 # Balancers, the regional internal Application Load Balancer, and the
1098 # regional internal proxy Network Load Balancer from all regions.
1099 # If false, only allows access from the local region the load balancer is
1100 # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
1101 # cannot be changed after the forwarding rule is created.
1102 &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
1103 # endpoint can be accessed from another region.
1104 &quot;attachedExtensions&quot;: [ # Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
1105 { # Reference to an extension resource that is attached to this ForwardingRule.
1106 &quot;reference&quot;: &quot;A String&quot;, # Output only. The resource name.
1107 },
1108 ],
1109 &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
1110 # Required for internal and external passthrough Network Load Balancers;
1111 # must be omitted for all other load balancer types.
1112 &quot;baseForwardingRule&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the corresponding base forwarding rule. By base
1113 # forwarding rule, we mean the forwarding rule that has the same IP address,
1114 # protocol, and port settings with the current forwarding rule, but without
1115 # sourceIPRanges specified.
1116 # Always empty if the current forwarding rule does not have sourceIPRanges
1117 # specified.
1118 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1119 # text format.
1120 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1121 # create the resource.
1122 &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
1123 # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
1124 # TEST_ALL_TRAFFIC.
1125 #
1126 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
1127 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
1128 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
1129 # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
1130 # attached to this forwarding rule by percentage using
1131 # externalManagedBackendBucketMigrationTestingPercentage.
1132 #
1133 # Rolling back a migration requires the states to be set in reverse order. So
1134 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
1135 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
1136 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
1137 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
1138 &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
1139 # processed by the global external Application Load Balancer.
1140 #
1141 # The value of this field must be in the range [0, 100].
1142 #
1143 # This value can only be set if the loadBalancingScheme in the BackendService
1144 # is set to EXTERNAL (when using the classic Application Load Balancer) and
1145 # the migration state is TEST_BY_PERCENTAGE.
1146 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1147 # This field is used in optimistic locking. This field will be ignored when
1148 # inserting a ForwardingRule. Include the fingerprint in patch request to
1149 # ensure that you do not overwrite changes that were applied from another
1150 # concurrent request.
1151 #
1152 # To see the latest fingerprint, make a get() request to
1153 # retrieve a ForwardingRule.
1154 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1155 # defined by the server.
1156 &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
1157 # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
1158 #
1159 # Use one of the following formats to specify a sub-PDP when creating an IPv6
1160 # NetLB forwarding rule using BYOIP:
1161 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
1162 # Partial URL, as in:
1163 #
1164 # - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
1165 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
1166 &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule. Valid options
1167 # are IPV4 or IPV6.
1168 &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
1169 # packet mirroring. To prevent mirroring loops, instances behind this
1170 # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
1171 # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
1172 &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
1173 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
1174 # essentially a hash of the labels set used for optimistic locking. The
1175 # fingerprint is initially generated by Compute Engine and changes after
1176 # every request to modify or update labels. You must always provide an
1177 # up-to-date fingerprint hash in order to update or change labels,
1178 # otherwise the request will fail with error412 conditionNotMet.
1179 #
1180 # To see the latest fingerprint, make a get() request to
1181 # retrieve a ForwardingRule.
1182 &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.
1183 # Label values may be empty.
1184 &quot;a_key&quot;: &quot;A String&quot;,
1185 },
1186 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
1187 #
1188 # For more information about forwarding rules, refer to
1189 # Forwarding rule concepts.
1190 &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
1191 # configuration to a limited set of xDS
1192 # compliant clients. In their xDS requests to load balancer, xDS clients
1193 # present node
1194 # metadata. When there is a match, the relevant configuration
1195 # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
1196 # referenced by the ForwardingRule are not visible to
1197 # those proxies.
1198 #
1199 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
1200 # the metadata. If its filterMatchCriteria is set to
1201 # MATCH_ALL, then all of its filterLabels must match with
1202 # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
1203 # in order to be considered a match.
1204 #
1205 # metadataFilters specified here will be applifed before
1206 # those specified in the UrlMap that thisForwardingRule references.
1207 #
1208 # metadataFilters only applies to Loadbalancers that have
1209 # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
1210 { # Opaque filter criteria used by load balancers to restrict routing
1211 # configuration to a limited set of load balancing proxies. Proxies and
1212 # sidecars involved in load balancing would typically present metadata to the
1213 # load balancers that need to match criteria specified here. If a match takes
1214 # place, the relevant configuration is made available to those
1215 # proxies.
1216 #
1217 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
1218 # one of thefilterLabels must match the corresponding label provided in
1219 # the metadata. If its filterMatchCriteria is set to
1220 # MATCH_ALL, then all of its filterLabels must match with
1221 # corresponding labels provided in the metadata.
1222 #
1223 # An example for using metadataFilters would be: if
1224 # load balancing involves
1225 # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in of their XDS requests to loadbalancers.
1226 &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
1227 # metadata based on filterMatchCriteria
1228 #
1229 # This list must not be empty and can have at the most 64 entries.
1230 { # MetadataFilter label name value pairs that are expected
1231 # to match corresponding labels presented as metadata to the load balancer.
1232 &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
1233 #
1234 # The name can have a maximum length of 1024 characters and must be at
1235 # least 1 character long.
1236 &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
1237 #
1238 # value can have a maximum length of 1024 characters.
1239 },
1240 ],
1241 &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
1242 # within the list of filterLabels and contributes toward the
1243 # overall metadataFilter match.
1244 #
1245 # Supported values are:
1246 #
1247 # - MATCH_ANY: at least one of the filterLabels
1248 # must have a matching label in the provided metadata.
1249 # - MATCH_ALL: all filterLabels must have
1250 # matching labels in the provided metadata.
1251 },
1252 ],
1253 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1254 # The name must be 1-63 characters long, and comply withRFC1035.
1255 # Specifically, the name must be 1-63 characters long and match the regular
1256 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1257 # character must be a lowercase letter, and all following characters must
1258 # be a dash, lowercase letter, or digit, except the last character, which
1259 # cannot be a dash.
1260 #
1261 # For Private Service Connect forwarding rules that forward traffic to Google
1262 # APIs, the forwarding rule name must be a 1-20 characters string with
1263 # lowercase letters and numbers and must start with a letter.
1264 &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
1265 #
1266 # For internal passthrough Network Load Balancers, this field identifies the
1267 # network that the load balanced IP should belong to for this forwarding
1268 # rule.
1269 # If the subnetwork is specified, the network of the subnetwork will be used.
1270 # If neither subnetwork nor this field is specified, the default network will
1271 # be used.
1272 #
1273 # For Private Service Connect forwarding rules that forward traffic to Google
1274 # APIs, a network must be provided.
1275 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
1276 # this load balancer and can only take the following values:PREMIUM, STANDARD.
1277 #
1278 # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
1279 #
1280 # If this field is not specified, it is assumed to be PREMIUM.
1281 # If IPAddress is specified, this value must be equal to the
1282 # networkTier of the Address.
1283 &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
1284 # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
1285 # this field. Once set, this field is not mutable.
1286 &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
1287 # fields are mutually exclusive. Only packets addressed to ports in the
1288 # specified range will be forwarded to the backends configured with this
1289 # forwarding rule.
1290 #
1291 # The portRange field has the following limitations:
1292 #
1293 # - It requires that the forwarding rule IPProtocol be TCP,
1294 # UDP, or SCTP, and
1295 # - It&#x27;s applicable only to the following products: external passthrough
1296 # Network Load Balancers, internal and external proxy Network Load Balancers,
1297 # internal and external Application Load Balancers, external protocol
1298 # forwarding, and Classic VPN.
1299 # - Some products have restrictions on what ports can be used. See
1300 # port specifications for details.
1301 #
1302 #
1303 #
1304 # For external forwarding rules, two or more forwarding rules cannot use the
1305 # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
1306 #
1307 # For internal forwarding rules within the same VPC network, two or more
1308 # forwarding rules cannot use the same [IPAddress, IPProtocol]
1309 # pair, and cannot have overlapping portRanges.
1310 #
1311 # @pattern: \\d+(?:-\\d+)?
1312 &quot;ports&quot;: [ # The ports, portRange, and allPorts
1313 # fields are mutually exclusive. Only packets addressed to ports in the
1314 # specified range will be forwarded to the backends configured with this
1315 # forwarding rule.
1316 #
1317 # The ports field has the following limitations:
1318 #
1319 # - It requires that the forwarding rule IPProtocol be TCP,
1320 # UDP, or SCTP, and
1321 # - It&#x27;s applicable only to the following products: internal passthrough
1322 # Network Load Balancers, backend service-based external passthrough Network
1323 # Load Balancers, and internal protocol forwarding.
1324 # - You can specify a list of up to five ports by number, separated by
1325 # commas. The ports can be contiguous or discontiguous.
1326 #
1327 #
1328 #
1329 # For external forwarding rules, two or more forwarding rules cannot use the
1330 # same [IPAddress, IPProtocol] pair if they share at least one
1331 # port number.
1332 #
1333 # For internal forwarding rules within the same VPC network, two or more
1334 # forwarding rules cannot use the same [IPAddress, IPProtocol]
1335 # pair if they share at least one port number.
1336 #
1337 # @pattern: \\d+(?:-\\d+)?
1338 &quot;A String&quot;,
1339 ],
1340 &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
1341 &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
1342 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional forwarding rule resides.
1343 # This field is not applicable to global forwarding rules.
1344 # You must specify this field as part of the HTTP request URL. It is
1345 # not settable as a field in the request body.
1346 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1347 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1348 &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
1349 # Currently, only supports a single Service Directory resource.
1350 { # Describes the auto-registration of the forwarding rule to Service Directory.
1351 # The region and project of the Service Directory resource generated from
1352 # this registration will be the same as this forwarding rule.
1353 &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
1354 &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
1355 &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
1356 # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
1357 # All PSC for Google APIs forwarding rules on the same network should use
1358 # the same Service Directory region.
1359 },
1360 ],
1361 &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
1362 # If specified, the prefix is the first label of the fully qualified service
1363 # name.
1364 #
1365 # The label must be 1-63 characters long, and comply withRFC1035.
1366 # Specifically, the label must be 1-63 characters long and match the regular
1367 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1368 # character must be a lowercase letter, and all following characters must
1369 # be a dash, lowercase letter, or digit, except the last character, which
1370 # cannot be a dash.
1371 #
1372 # This field is only used for internal load balancing.
1373 &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
1374 # The internal fully qualified service name for this forwarding rule.
1375 #
1376 # This field is only used for internal load balancing.
1377 &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
1378 # source IP address matches one of the IP addresses or CIDR ranges set here.
1379 # Note that a forwarding rule can only have up to 64 source IP ranges, and
1380 # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
1381 # Each source_ip_range entry should be either an IP address (for
1382 # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
1383 &quot;A String&quot;,
1384 ],
1385 &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
1386 # belong to for this forwarding rule, used with internal load balancers and
1387 # external passthrough Network Load Balancers with IPv6.
1388 #
1389 # If the network specified is in auto subnet mode, this field is optional.
1390 # However, a subnetwork must be specified if the network is in custom subnet
1391 # mode or when creating external forwarding rule with IPv6.
1392 &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic. For
1393 # regional forwarding rules, this target must be in the same region as the
1394 # forwarding rule. For global forwarding rules, this target must be a global
1395 # load balancing resource.
1396 #
1397 # The forwarded traffic must be of a type appropriate to the target object.
1398 #
1399 #
1400 # - For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
1401 # - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
1402 #
1403 #
1404 # - vpc-sc - APIs that support VPC Service Controls.
1405 # - all-apis - All supported Google APIs.
1406 #
1407 #
1408 # - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
1409 }</pre>
1410 </div>
1411
1412 <div class="method">
1413 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
1414 <pre>Creates a ForwardingRule resource in the specified project and region using
1415 the data included in the request.
1416
1417 Args:
1418 project: string, Project ID for this request. (required)
1419 region: string, Name of the region scoping this request. (required)
1420 body: object, The request body.
1421 The object takes the form of:
1422
1423 { # Represents a Forwarding Rule resource.
1424 #
1425 # Forwarding rule resources in Google Cloud can be either regional or global in
1426 # scope:
1427 #
1428 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
1429 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
1430 #
1431 # A forwarding rule and its corresponding IP address represent the frontend
1432 # configuration of a Google Cloud load balancer.
1433 # Forwarding rules can also reference target instances and Cloud VPN Classic
1434 # gateways (targetVpnGateway).
1435 #
1436 # For more information, read
1437 # Forwarding rule concepts and
1438 # Using protocol forwarding.
1439 &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
1440 # sends traffic to this IP address, the forwarding rule directs the traffic
1441 # to the referenced target or backendService.
1442 # While creating a forwarding rule, specifying an IPAddress is
1443 # required under the following circumstances:
1444 #
1445 #
1446 # - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
1447 # - When the target is a Private Service Connect Google APIs
1448 # bundle, you must specify an IPAddress.
1449 #
1450 #
1451 # Otherwise, you can optionally specify an IP address that references an
1452 # existing static (reserved) IP address resource. When omitted, Google Cloud
1453 # assigns an ephemeral IP address.
1454 #
1455 # Use one of the following formats to specify an IP address while creating a
1456 # forwarding rule:
1457 #
1458 # * IP address number, as in `100.1.2.3`
1459 # * IPv6 address range, as in `2600:1234::/96`
1460 # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
1461 # * Partial URL or by name, as in:
1462 #
1463 # - projects/project_id/regions/region/addresses/address-name
1464 # - regions/region/addresses/address-name
1465 # - global/addresses/address-name
1466 # - address-name
1467 #
1468 #
1469 #
1470 # The forwarding rule&#x27;s target or backendService,
1471 # and in most cases, also the loadBalancingScheme, determine the
1472 # type of IP address that you can use. For detailed information, see
1473 # [IP address
1474 # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
1475 #
1476 # When reading an IPAddress, the API always returns the IP
1477 # address number.
1478 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
1479 #
1480 # For protocol forwarding, valid
1481 # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
1482 #
1483 # The valid IP protocols are different for different load balancing products
1484 # as described in [Load balancing
1485 # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
1486 &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
1487 # fields are mutually exclusive. Only packets addressed to ports in the
1488 # specified range will be forwarded to the backends configured with this
1489 # forwarding rule.
1490 #
1491 # The allPorts field has the following limitations:
1492 #
1493 # - It requires that the forwarding rule IPProtocol be TCP,
1494 # UDP, SCTP, or L3_DEFAULT.
1495 # - It&#x27;s applicable only to the following products: internal passthrough
1496 # Network Load Balancers, backend service-based external passthrough Network
1497 # Load Balancers, and internal and external protocol forwarding.
1498 # - Set this field to true to allow packets addressed to any port or
1499 # packets lacking destination port information (for example, UDP fragments
1500 # after the first fragment) to be forwarded to the backends configured with
1501 # this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
1502 &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
1503 # Balancers, the regional internal Application Load Balancer, and the
1504 # regional internal proxy Network Load Balancer from all regions.
1505 # If false, only allows access from the local region the load balancer is
1506 # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
1507 # cannot be changed after the forwarding rule is created.
1508 &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
1509 # endpoint can be accessed from another region.
1510 &quot;attachedExtensions&quot;: [ # Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
1511 { # Reference to an extension resource that is attached to this ForwardingRule.
1512 &quot;reference&quot;: &quot;A String&quot;, # Output only. The resource name.
1513 },
1514 ],
1515 &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
1516 # Required for internal and external passthrough Network Load Balancers;
1517 # must be omitted for all other load balancer types.
1518 &quot;baseForwardingRule&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the corresponding base forwarding rule. By base
1519 # forwarding rule, we mean the forwarding rule that has the same IP address,
1520 # protocol, and port settings with the current forwarding rule, but without
1521 # sourceIPRanges specified.
1522 # Always empty if the current forwarding rule does not have sourceIPRanges
1523 # specified.
1524 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1525 # text format.
1526 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1527 # create the resource.
1528 &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
1529 # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
1530 # TEST_ALL_TRAFFIC.
1531 #
1532 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
1533 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
1534 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
1535 # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
1536 # attached to this forwarding rule by percentage using
1537 # externalManagedBackendBucketMigrationTestingPercentage.
1538 #
1539 # Rolling back a migration requires the states to be set in reverse order. So
1540 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
1541 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
1542 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
1543 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
1544 &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
1545 # processed by the global external Application Load Balancer.
1546 #
1547 # The value of this field must be in the range [0, 100].
1548 #
1549 # This value can only be set if the loadBalancingScheme in the BackendService
1550 # is set to EXTERNAL (when using the classic Application Load Balancer) and
1551 # the migration state is TEST_BY_PERCENTAGE.
1552 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1553 # This field is used in optimistic locking. This field will be ignored when
1554 # inserting a ForwardingRule. Include the fingerprint in patch request to
1555 # ensure that you do not overwrite changes that were applied from another
1556 # concurrent request.
1557 #
1558 # To see the latest fingerprint, make a get() request to
1559 # retrieve a ForwardingRule.
1560 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1561 # defined by the server.
1562 &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
1563 # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
1564 #
1565 # Use one of the following formats to specify a sub-PDP when creating an IPv6
1566 # NetLB forwarding rule using BYOIP:
1567 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
1568 # Partial URL, as in:
1569 #
1570 # - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
1571 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
1572 &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule. Valid options
1573 # are IPV4 or IPV6.
1574 &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
1575 # packet mirroring. To prevent mirroring loops, instances behind this
1576 # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
1577 # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
1578 &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
1579 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
1580 # essentially a hash of the labels set used for optimistic locking. The
1581 # fingerprint is initially generated by Compute Engine and changes after
1582 # every request to modify or update labels. You must always provide an
1583 # up-to-date fingerprint hash in order to update or change labels,
1584 # otherwise the request will fail with error412 conditionNotMet.
1585 #
1586 # To see the latest fingerprint, make a get() request to
1587 # retrieve a ForwardingRule.
1588 &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.
1589 # Label values may be empty.
1590 &quot;a_key&quot;: &quot;A String&quot;,
1591 },
1592 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
1593 #
1594 # For more information about forwarding rules, refer to
1595 # Forwarding rule concepts.
1596 &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
1597 # configuration to a limited set of xDS
1598 # compliant clients. In their xDS requests to load balancer, xDS clients
1599 # present node
1600 # metadata. When there is a match, the relevant configuration
1601 # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
1602 # referenced by the ForwardingRule are not visible to
1603 # those proxies.
1604 #
1605 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
1606 # the metadata. If its filterMatchCriteria is set to
1607 # MATCH_ALL, then all of its filterLabels must match with
1608 # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
1609 # in order to be considered a match.
1610 #
1611 # metadataFilters specified here will be applifed before
1612 # those specified in the UrlMap that thisForwardingRule references.
1613 #
1614 # metadataFilters only applies to Loadbalancers that have
1615 # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
1616 { # Opaque filter criteria used by load balancers to restrict routing
1617 # configuration to a limited set of load balancing proxies. Proxies and
1618 # sidecars involved in load balancing would typically present metadata to the
1619 # load balancers that need to match criteria specified here. If a match takes
1620 # place, the relevant configuration is made available to those
1621 # proxies.
1622 #
1623 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
1624 # one of thefilterLabels must match the corresponding label provided in
1625 # the metadata. If its filterMatchCriteria is set to
1626 # MATCH_ALL, then all of its filterLabels must match with
1627 # corresponding labels provided in the metadata.
1628 #
1629 # An example for using metadataFilters would be: if
1630 # load balancing involves
1631 # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in of their XDS requests to loadbalancers.
1632 &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
1633 # metadata based on filterMatchCriteria
1634 #
1635 # This list must not be empty and can have at the most 64 entries.
1636 { # MetadataFilter label name value pairs that are expected
1637 # to match corresponding labels presented as metadata to the load balancer.
1638 &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
1639 #
1640 # The name can have a maximum length of 1024 characters and must be at
1641 # least 1 character long.
1642 &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
1643 #
1644 # value can have a maximum length of 1024 characters.
1645 },
1646 ],
1647 &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
1648 # within the list of filterLabels and contributes toward the
1649 # overall metadataFilter match.
1650 #
1651 # Supported values are:
1652 #
1653 # - MATCH_ANY: at least one of the filterLabels
1654 # must have a matching label in the provided metadata.
1655 # - MATCH_ALL: all filterLabels must have
1656 # matching labels in the provided metadata.
1657 },
1658 ],
1659 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1660 # The name must be 1-63 characters long, and comply withRFC1035.
1661 # Specifically, the name must be 1-63 characters long and match the regular
1662 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1663 # character must be a lowercase letter, and all following characters must
1664 # be a dash, lowercase letter, or digit, except the last character, which
1665 # cannot be a dash.
1666 #
1667 # For Private Service Connect forwarding rules that forward traffic to Google
1668 # APIs, the forwarding rule name must be a 1-20 characters string with
1669 # lowercase letters and numbers and must start with a letter.
1670 &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
1671 #
1672 # For internal passthrough Network Load Balancers, this field identifies the
1673 # network that the load balanced IP should belong to for this forwarding
1674 # rule.
1675 # If the subnetwork is specified, the network of the subnetwork will be used.
1676 # If neither subnetwork nor this field is specified, the default network will
1677 # be used.
1678 #
1679 # For Private Service Connect forwarding rules that forward traffic to Google
1680 # APIs, a network must be provided.
1681 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
1682 # this load balancer and can only take the following values:PREMIUM, STANDARD.
1683 #
1684 # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
1685 #
1686 # If this field is not specified, it is assumed to be PREMIUM.
1687 # If IPAddress is specified, this value must be equal to the
1688 # networkTier of the Address.
1689 &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
1690 # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
1691 # this field. Once set, this field is not mutable.
1692 &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
1693 # fields are mutually exclusive. Only packets addressed to ports in the
1694 # specified range will be forwarded to the backends configured with this
1695 # forwarding rule.
1696 #
1697 # The portRange field has the following limitations:
1698 #
1699 # - It requires that the forwarding rule IPProtocol be TCP,
1700 # UDP, or SCTP, and
1701 # - It&#x27;s applicable only to the following products: external passthrough
1702 # Network Load Balancers, internal and external proxy Network Load Balancers,
1703 # internal and external Application Load Balancers, external protocol
1704 # forwarding, and Classic VPN.
1705 # - Some products have restrictions on what ports can be used. See
1706 # port specifications for details.
1707 #
1708 #
1709 #
1710 # For external forwarding rules, two or more forwarding rules cannot use the
1711 # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
1712 #
1713 # For internal forwarding rules within the same VPC network, two or more
1714 # forwarding rules cannot use the same [IPAddress, IPProtocol]
1715 # pair, and cannot have overlapping portRanges.
1716 #
1717 # @pattern: \\d+(?:-\\d+)?
1718 &quot;ports&quot;: [ # The ports, portRange, and allPorts
1719 # fields are mutually exclusive. Only packets addressed to ports in the
1720 # specified range will be forwarded to the backends configured with this
1721 # forwarding rule.
1722 #
1723 # The ports field has the following limitations:
1724 #
1725 # - It requires that the forwarding rule IPProtocol be TCP,
1726 # UDP, or SCTP, and
1727 # - It&#x27;s applicable only to the following products: internal passthrough
1728 # Network Load Balancers, backend service-based external passthrough Network
1729 # Load Balancers, and internal protocol forwarding.
1730 # - You can specify a list of up to five ports by number, separated by
1731 # commas. The ports can be contiguous or discontiguous.
1732 #
1733 #
1734 #
1735 # For external forwarding rules, two or more forwarding rules cannot use the
1736 # same [IPAddress, IPProtocol] pair if they share at least one
1737 # port number.
1738 #
1739 # For internal forwarding rules within the same VPC network, two or more
1740 # forwarding rules cannot use the same [IPAddress, IPProtocol]
1741 # pair if they share at least one port number.
1742 #
1743 # @pattern: \\d+(?:-\\d+)?
1744 &quot;A String&quot;,
1745 ],
1746 &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
1747 &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
1748 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional forwarding rule resides.
1749 # This field is not applicable to global forwarding rules.
1750 # You must specify this field as part of the HTTP request URL. It is
1751 # not settable as a field in the request body.
1752 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1753 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1754 &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
1755 # Currently, only supports a single Service Directory resource.
1756 { # Describes the auto-registration of the forwarding rule to Service Directory.
1757 # The region and project of the Service Directory resource generated from
1758 # this registration will be the same as this forwarding rule.
1759 &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
1760 &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
1761 &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
1762 # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
1763 # All PSC for Google APIs forwarding rules on the same network should use
1764 # the same Service Directory region.
1765 },
1766 ],
1767 &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
1768 # If specified, the prefix is the first label of the fully qualified service
1769 # name.
1770 #
1771 # The label must be 1-63 characters long, and comply withRFC1035.
1772 # Specifically, the label must be 1-63 characters long and match the regular
1773 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1774 # character must be a lowercase letter, and all following characters must
1775 # be a dash, lowercase letter, or digit, except the last character, which
1776 # cannot be a dash.
1777 #
1778 # This field is only used for internal load balancing.
1779 &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
1780 # The internal fully qualified service name for this forwarding rule.
1781 #
1782 # This field is only used for internal load balancing.
1783 &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
1784 # source IP address matches one of the IP addresses or CIDR ranges set here.
1785 # Note that a forwarding rule can only have up to 64 source IP ranges, and
1786 # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
1787 # Each source_ip_range entry should be either an IP address (for
1788 # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
1789 &quot;A String&quot;,
1790 ],
1791 &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
1792 # belong to for this forwarding rule, used with internal load balancers and
1793 # external passthrough Network Load Balancers with IPv6.
1794 #
1795 # If the network specified is in auto subnet mode, this field is optional.
1796 # However, a subnetwork must be specified if the network is in custom subnet
1797 # mode or when creating external forwarding rule with IPv6.
1798 &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic. For
1799 # regional forwarding rules, this target must be in the same region as the
1800 # forwarding rule. For global forwarding rules, this target must be a global
1801 # load balancing resource.
1802 #
1803 # The forwarded traffic must be of a type appropriate to the target object.
1804 #
1805 #
1806 # - For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
1807 # - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
1808 #
1809 #
1810 # - vpc-sc - APIs that support VPC Service Controls.
1811 # - all-apis - All supported Google APIs.
1812 #
1813 #
1814 # - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
1815 }
1816
1817 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1818 that if you must retry your request, the server will know to ignore the
1819 request if it has already been completed.
1820
1821 For example, consider a situation where you make an initial request and
1822 the request times out. If you make the request again with the same
1823 request ID, the server can check if original operation with the same
1824 request ID was received, and if so, will ignore the second request. This
1825 prevents clients from accidentally creating duplicate commitments.
1826
1827 The request ID must be
1828 a valid UUID with the exception that zero UUID is not supported
1829 (00000000-0000-0000-0000-000000000000).
1830 x__xgafv: string, V1 error format.
1831 Allowed values
1832 1 - v1 error format
1833 2 - v2 error format
1834
1835 Returns:
1836 An object of the form:
1837
1838 { # Represents an Operation resource.
1839 #
1840 # Google Compute Engine has three Operation resources:
1841 #
1842 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1843 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1844 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1845 #
1846 # You can use an operation resource to manage asynchronous API requests.
1847 # For more information, readHandling
1848 # API responses.
1849 #
1850 # Operations can be global, regional or zonal.
1851 #
1852 # - For global operations, use the `globalOperations`
1853 # resource.
1854 # - For regional operations, use the
1855 # `regionOperations` resource.
1856 # - For zonal operations, use
1857 # the `zoneOperations` resource.
1858 #
1859 #
1860 #
1861 # For more information, read
1862 # Global, Regional, and Zonal Resources.
1863 #
1864 # Note that completed Operation resources have a limited
1865 # retention period.
1866 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1867 # Not present otherwise.
1868 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1869 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1870 # set when the operation is created.
1871 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1872 # text format.
1873 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1874 # this field will be populated.
1875 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1876 # operation.
1877 {
1878 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1879 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1880 # details. There is a set of defined message types to use for providing
1881 # details.The syntax depends on the error code. For example,
1882 # QuotaExceededInfo will have details when the error code is
1883 # QUOTA_EXCEEDED.
1884 {
1885 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1886 #
1887 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1888 # is not enabled:
1889 #
1890 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1891 # &quot;domain&quot;: &quot;googleapis.com&quot;
1892 # &quot;metadata&quot;: {
1893 # &quot;resource&quot;: &quot;projects/123&quot;,
1894 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1895 # }
1896 # }
1897 #
1898 # This response indicates that the pubsub.googleapis.com API is not enabled.
1899 #
1900 # Example of an error that is returned when attempting to create a Spanner
1901 # instance in a region that is out of stock:
1902 #
1903 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1904 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1905 # &quot;metadata&quot;: {
1906 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1907 # }
1908 # }
1909 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1910 # is typically the registered service name of the tool or product that
1911 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1912 # generated by some common infrastructure, the error domain must be a
1913 # globally unique value that identifies the infrastructure. For Google API
1914 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1915 &quot;metadatas&quot;: { # Additional structured details about this error.
1916 #
1917 # Keys must match a regular expression of `a-z+` but should
1918 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1919 # length. When identifying the current value of an exceeded limit, the units
1920 # should be contained in the key, not the value. For example, rather than
1921 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1922 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1923 # instances that can be created in a single (batch) request.
1924 &quot;a_key&quot;: &quot;A String&quot;,
1925 },
1926 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1927 # proximate cause of the error. Error reasons are unique within a particular
1928 # domain of errors. This should be at most 63 characters and match a
1929 # regular expression of `A-Z+[A-Z0-9]`, which represents
1930 # UPPER_SNAKE_CASE.
1931 },
1932 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1933 #
1934 # For example, if a quota check failed with an error indicating the calling
1935 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1936 # directly to the right place in the developer console to flip the bit.
1937 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1938 { # Describes a URL link.
1939 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1940 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1941 },
1942 ],
1943 },
1944 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1945 # which can be attached to an RPC error.
1946 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1947 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1948 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1949 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1950 },
1951 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1952 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1953 &quot;a_key&quot;: &quot;A String&quot;,
1954 },
1955 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1956 # type or metric.
1957 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1958 # or metric.
1959 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1960 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1961 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1962 },
1963 },
1964 ],
1965 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1966 # This property is optional.
1967 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1968 },
1969 ],
1970 },
1971 &quot;getVersionOperationMetadata&quot;: {
1972 &quot;inlineSbomInfo&quot;: {
1973 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1974 # appropriate identifiers.
1975 &quot;a_key&quot;: &quot;A String&quot;,
1976 },
1977 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1978 # identifiers.
1979 &quot;a_key&quot;: &quot;A String&quot;,
1980 },
1981 },
1982 },
1983 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1984 # message that was returned, such as `NOT FOUND`.
1985 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1986 # status code that was returned. For example, a `404` means the
1987 # resource was not found.
1988 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1989 # defined by the server.
1990 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1991 # This value is inRFC3339
1992 # text format.
1993 &quot;instancesBulkInsertOperationMetadata&quot;: {
1994 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1995 # Example key: zones/us-central1-a
1996 &quot;a_key&quot;: {
1997 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1998 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1999 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2000 # error.
2001 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2002 # if the flow is rolling forward or rolling back.
2003 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2004 },
2005 },
2006 },
2007 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2008 # Operation resources.
2009 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2010 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2011 # group of operations results from a `bulkInsert` API request.
2012 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2013 # `update`, or `delete`, and so on.
2014 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2015 # There is no requirement that this be linear or support any granularity of
2016 # operations. This should not be used to guess when the operation will be
2017 # complete. This number should monotonically increase as the operation
2018 # progresses.
2019 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2020 # applicable when performing regional operations.
2021 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2022 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2023 # this field will contain information on all underlying zonal actions and
2024 # their state.
2025 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2026 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2027 # Example key: zones/us-central1-a
2028 &quot;a_key&quot;: {
2029 &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
2030 # populated.
2031 # different programming environments, including REST APIs and RPC APIs. It is
2032 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2033 # three pieces of data: error code, error message, and error details.
2034 #
2035 # You can find out more about this error model and how to work with it in the
2036 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2037 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2038 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2039 # message types for APIs to use.
2040 {
2041 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2042 },
2043 ],
2044 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2045 # user-facing error message should be localized and sent in the
2046 # google.rpc.Status.details field, or localized by the client.
2047 },
2048 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2049 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2050 },
2051 },
2052 },
2053 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2054 # This value is inRFC3339
2055 # text format.
2056 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2057 # following:
2058 # `PENDING`, `RUNNING`, or `DONE`.
2059 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2060 # operation.
2061 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2062 # of the target resource.
2063 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2064 # operations related to creating a snapshot, this points to the disk
2065 # that the snapshot was created from.
2066 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2067 # `[email protected]` or
2068 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2069 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2070 # operation, this field will be populated.
2071 {
2072 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2073 # Engine returns NO_RESULTS_ON_PAGE if there
2074 # are no results in the response.
2075 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2076 # value format. For example:
2077 #
2078 # &quot;data&quot;: [
2079 # {
2080 # &quot;key&quot;: &quot;scope&quot;,
2081 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2082 # }
2083 {
2084 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2085 # returned. For example, for warnings where there are no results in a list
2086 # request for a particular zone, this key might be scope and
2087 # the key value might be the zone name. Other examples might be a key
2088 # indicating a deprecated resource and a suggested replacement, or a
2089 # warning about invalid network settings (for example, if an instance
2090 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2091 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2092 },
2093 ],
2094 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2095 },
2096 ],
2097 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2098 # applicable when performing per-zone operations.
2099 }</pre>
2100 </div>
2101
2102 <div class="method">
2103 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2104 <pre>Retrieves a list of ForwardingRule resources available to the specified
2105 project and region.
2106
2107 Args:
2108 project: string, Project ID for this request. (required)
2109 region: string, Name of the region scoping this request. (required)
2110 filter: string, A filter expression that filters resources listed in the response. Most
2111 Compute resources support two types of filter expressions:
2112 expressions that support regular expressions and expressions that follow
2113 API improvement proposal AIP-160.
2114 These two types of filter expressions cannot be mixed in one request.
2115
2116 If you want to use AIP-160, your expression must specify the field name, an
2117 operator, and the value that you want to use for filtering. The value
2118 must be a string, a number, or a boolean. The operator
2119 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2120
2121 For example, if you are filtering Compute Engine instances, you can
2122 exclude instances named `example-instance` by specifying
2123 `name != example-instance`.
2124
2125 The `:*` comparison can be used to test whether a key has been defined.
2126 For example, to find all objects with `owner` label use:
2127 ```
2128 labels.owner:*
2129 ```
2130
2131 You can also filter nested fields. For example, you could specify
2132 `scheduling.automaticRestart = false` to include instances only
2133 if they are not scheduled for automatic restarts. You can use filtering
2134 on nested fields to filter based onresource labels.
2135
2136 To filter on multiple expressions, provide each separate expression within
2137 parentheses. For example:
2138 ```
2139 (scheduling.automaticRestart = true)
2140 (cpuPlatform = &quot;Intel Skylake&quot;)
2141 ```
2142 By default, each expression is an `AND` expression. However, you
2143 can include `AND` and `OR` expressions explicitly.
2144 For example:
2145 ```
2146 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2147 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2148 (scheduling.automaticRestart = true)
2149 ```
2150
2151 If you want to use a regular expression, use the `eq` (equal) or `ne`
2152 (not equal) operator against a single un-parenthesized expression with or
2153 without quotes or against multiple parenthesized expressions. Examples:
2154
2155 `fieldname eq unquoted literal`
2156 `fieldname eq &#x27;single quoted literal&#x27;`
2157 `fieldname eq &quot;double quoted literal&quot;`
2158 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2159
2160 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2161 The literal value must match the entire field.
2162
2163 For example, to filter for instances that do not end with name &quot;instance&quot;,
2164 you would use `name ne .*instance`.
2165
2166 You cannot combine constraints on multiple fields using regular
2167 expressions.
2168 maxResults: integer, The maximum number of results per page that should be returned.
2169 If the number of available results is larger than `maxResults`,
2170 Compute Engine returns a `nextPageToken` that can be used to get
2171 the next page of results in subsequent list requests. Acceptable values are
2172 `0` to `500`, inclusive. (Default: `500`)
2173 orderBy: string, Sorts list results by a certain order. By default, results
2174 are returned in alphanumerical order based on the resource name.
2175
2176 You can also sort results in descending order based on the creation
2177 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2178 results based on the `creationTimestamp` field in
2179 reverse chronological order (newest result first). Use this to sort
2180 resources like operations so that the newest operation is returned first.
2181
2182 Currently, only sorting by `name` or
2183 `creationTimestamp desc` is supported.
2184 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2185 `nextPageToken` returned by a previous list request to get
2186 the next page of results.
2187 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2188 of failure. The default value is false.
2189
2190 For example, when partial success behavior is enabled, aggregatedList for a
2191 single zone scope either returns all resources in the zone or no resources,
2192 with an error code.
2193 x__xgafv: string, V1 error format.
2194 Allowed values
2195 1 - v1 error format
2196 2 - v2 error format
2197
2198 Returns:
2199 An object of the form:
2200
2201 { # Contains a list of ForwardingRule resources.
2202 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2203 &quot;items&quot;: [ # A list of ForwardingRule resources.
2204 { # Represents a Forwarding Rule resource.
2205 #
2206 # Forwarding rule resources in Google Cloud can be either regional or global in
2207 # scope:
2208 #
2209 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
2210 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
2211 #
2212 # A forwarding rule and its corresponding IP address represent the frontend
2213 # configuration of a Google Cloud load balancer.
2214 # Forwarding rules can also reference target instances and Cloud VPN Classic
2215 # gateways (targetVpnGateway).
2216 #
2217 # For more information, read
2218 # Forwarding rule concepts and
2219 # Using protocol forwarding.
2220 &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
2221 # sends traffic to this IP address, the forwarding rule directs the traffic
2222 # to the referenced target or backendService.
2223 # While creating a forwarding rule, specifying an IPAddress is
2224 # required under the following circumstances:
2225 #
2226 #
2227 # - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
2228 # - When the target is a Private Service Connect Google APIs
2229 # bundle, you must specify an IPAddress.
2230 #
2231 #
2232 # Otherwise, you can optionally specify an IP address that references an
2233 # existing static (reserved) IP address resource. When omitted, Google Cloud
2234 # assigns an ephemeral IP address.
2235 #
2236 # Use one of the following formats to specify an IP address while creating a
2237 # forwarding rule:
2238 #
2239 # * IP address number, as in `100.1.2.3`
2240 # * IPv6 address range, as in `2600:1234::/96`
2241 # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
2242 # * Partial URL or by name, as in:
2243 #
2244 # - projects/project_id/regions/region/addresses/address-name
2245 # - regions/region/addresses/address-name
2246 # - global/addresses/address-name
2247 # - address-name
2248 #
2249 #
2250 #
2251 # The forwarding rule&#x27;s target or backendService,
2252 # and in most cases, also the loadBalancingScheme, determine the
2253 # type of IP address that you can use. For detailed information, see
2254 # [IP address
2255 # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
2256 #
2257 # When reading an IPAddress, the API always returns the IP
2258 # address number.
2259 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
2260 #
2261 # For protocol forwarding, valid
2262 # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
2263 #
2264 # The valid IP protocols are different for different load balancing products
2265 # as described in [Load balancing
2266 # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
2267 &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
2268 # fields are mutually exclusive. Only packets addressed to ports in the
2269 # specified range will be forwarded to the backends configured with this
2270 # forwarding rule.
2271 #
2272 # The allPorts field has the following limitations:
2273 #
2274 # - It requires that the forwarding rule IPProtocol be TCP,
2275 # UDP, SCTP, or L3_DEFAULT.
2276 # - It&#x27;s applicable only to the following products: internal passthrough
2277 # Network Load Balancers, backend service-based external passthrough Network
2278 # Load Balancers, and internal and external protocol forwarding.
2279 # - Set this field to true to allow packets addressed to any port or
2280 # packets lacking destination port information (for example, UDP fragments
2281 # after the first fragment) to be forwarded to the backends configured with
2282 # this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
2283 &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
2284 # Balancers, the regional internal Application Load Balancer, and the
2285 # regional internal proxy Network Load Balancer from all regions.
2286 # If false, only allows access from the local region the load balancer is
2287 # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
2288 # cannot be changed after the forwarding rule is created.
2289 &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
2290 # endpoint can be accessed from another region.
2291 &quot;attachedExtensions&quot;: [ # Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
2292 { # Reference to an extension resource that is attached to this ForwardingRule.
2293 &quot;reference&quot;: &quot;A String&quot;, # Output only. The resource name.
2294 },
2295 ],
2296 &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
2297 # Required for internal and external passthrough Network Load Balancers;
2298 # must be omitted for all other load balancer types.
2299 &quot;baseForwardingRule&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the corresponding base forwarding rule. By base
2300 # forwarding rule, we mean the forwarding rule that has the same IP address,
2301 # protocol, and port settings with the current forwarding rule, but without
2302 # sourceIPRanges specified.
2303 # Always empty if the current forwarding rule does not have sourceIPRanges
2304 # specified.
2305 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2306 # text format.
2307 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2308 # create the resource.
2309 &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
2310 # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
2311 # TEST_ALL_TRAFFIC.
2312 #
2313 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
2314 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
2315 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
2316 # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
2317 # attached to this forwarding rule by percentage using
2318 # externalManagedBackendBucketMigrationTestingPercentage.
2319 #
2320 # Rolling back a migration requires the states to be set in reverse order. So
2321 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
2322 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
2323 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
2324 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
2325 &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
2326 # processed by the global external Application Load Balancer.
2327 #
2328 # The value of this field must be in the range [0, 100].
2329 #
2330 # This value can only be set if the loadBalancingScheme in the BackendService
2331 # is set to EXTERNAL (when using the classic Application Load Balancer) and
2332 # the migration state is TEST_BY_PERCENTAGE.
2333 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
2334 # This field is used in optimistic locking. This field will be ignored when
2335 # inserting a ForwardingRule. Include the fingerprint in patch request to
2336 # ensure that you do not overwrite changes that were applied from another
2337 # concurrent request.
2338 #
2339 # To see the latest fingerprint, make a get() request to
2340 # retrieve a ForwardingRule.
2341 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2342 # defined by the server.
2343 &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
2344 # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
2345 #
2346 # Use one of the following formats to specify a sub-PDP when creating an IPv6
2347 # NetLB forwarding rule using BYOIP:
2348 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
2349 # Partial URL, as in:
2350 #
2351 # - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
2352 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
2353 &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule. Valid options
2354 # are IPV4 or IPV6.
2355 &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
2356 # packet mirroring. To prevent mirroring loops, instances behind this
2357 # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
2358 # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
2359 &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
2360 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
2361 # essentially a hash of the labels set used for optimistic locking. The
2362 # fingerprint is initially generated by Compute Engine and changes after
2363 # every request to modify or update labels. You must always provide an
2364 # up-to-date fingerprint hash in order to update or change labels,
2365 # otherwise the request will fail with error412 conditionNotMet.
2366 #
2367 # To see the latest fingerprint, make a get() request to
2368 # retrieve a ForwardingRule.
2369 &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.
2370 # Label values may be empty.
2371 &quot;a_key&quot;: &quot;A String&quot;,
2372 },
2373 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
2374 #
2375 # For more information about forwarding rules, refer to
2376 # Forwarding rule concepts.
2377 &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
2378 # configuration to a limited set of xDS
2379 # compliant clients. In their xDS requests to load balancer, xDS clients
2380 # present node
2381 # metadata. When there is a match, the relevant configuration
2382 # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
2383 # referenced by the ForwardingRule are not visible to
2384 # those proxies.
2385 #
2386 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
2387 # the metadata. If its filterMatchCriteria is set to
2388 # MATCH_ALL, then all of its filterLabels must match with
2389 # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
2390 # in order to be considered a match.
2391 #
2392 # metadataFilters specified here will be applifed before
2393 # those specified in the UrlMap that thisForwardingRule references.
2394 #
2395 # metadataFilters only applies to Loadbalancers that have
2396 # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
2397 { # Opaque filter criteria used by load balancers to restrict routing
2398 # configuration to a limited set of load balancing proxies. Proxies and
2399 # sidecars involved in load balancing would typically present metadata to the
2400 # load balancers that need to match criteria specified here. If a match takes
2401 # place, the relevant configuration is made available to those
2402 # proxies.
2403 #
2404 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
2405 # one of thefilterLabels must match the corresponding label provided in
2406 # the metadata. If its filterMatchCriteria is set to
2407 # MATCH_ALL, then all of its filterLabels must match with
2408 # corresponding labels provided in the metadata.
2409 #
2410 # An example for using metadataFilters would be: if
2411 # load balancing involves
2412 # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in of their XDS requests to loadbalancers.
2413 &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
2414 # metadata based on filterMatchCriteria
2415 #
2416 # This list must not be empty and can have at the most 64 entries.
2417 { # MetadataFilter label name value pairs that are expected
2418 # to match corresponding labels presented as metadata to the load balancer.
2419 &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
2420 #
2421 # The name can have a maximum length of 1024 characters and must be at
2422 # least 1 character long.
2423 &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
2424 #
2425 # value can have a maximum length of 1024 characters.
2426 },
2427 ],
2428 &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
2429 # within the list of filterLabels and contributes toward the
2430 # overall metadataFilter match.
2431 #
2432 # Supported values are:
2433 #
2434 # - MATCH_ANY: at least one of the filterLabels
2435 # must have a matching label in the provided metadata.
2436 # - MATCH_ALL: all filterLabels must have
2437 # matching labels in the provided metadata.
2438 },
2439 ],
2440 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
2441 # The name must be 1-63 characters long, and comply withRFC1035.
2442 # Specifically, the name must be 1-63 characters long and match the regular
2443 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2444 # character must be a lowercase letter, and all following characters must
2445 # be a dash, lowercase letter, or digit, except the last character, which
2446 # cannot be a dash.
2447 #
2448 # For Private Service Connect forwarding rules that forward traffic to Google
2449 # APIs, the forwarding rule name must be a 1-20 characters string with
2450 # lowercase letters and numbers and must start with a letter.
2451 &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
2452 #
2453 # For internal passthrough Network Load Balancers, this field identifies the
2454 # network that the load balanced IP should belong to for this forwarding
2455 # rule.
2456 # If the subnetwork is specified, the network of the subnetwork will be used.
2457 # If neither subnetwork nor this field is specified, the default network will
2458 # be used.
2459 #
2460 # For Private Service Connect forwarding rules that forward traffic to Google
2461 # APIs, a network must be provided.
2462 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
2463 # this load balancer and can only take the following values:PREMIUM, STANDARD.
2464 #
2465 # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
2466 #
2467 # If this field is not specified, it is assumed to be PREMIUM.
2468 # If IPAddress is specified, this value must be equal to the
2469 # networkTier of the Address.
2470 &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
2471 # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
2472 # this field. Once set, this field is not mutable.
2473 &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
2474 # fields are mutually exclusive. Only packets addressed to ports in the
2475 # specified range will be forwarded to the backends configured with this
2476 # forwarding rule.
2477 #
2478 # The portRange field has the following limitations:
2479 #
2480 # - It requires that the forwarding rule IPProtocol be TCP,
2481 # UDP, or SCTP, and
2482 # - It&#x27;s applicable only to the following products: external passthrough
2483 # Network Load Balancers, internal and external proxy Network Load Balancers,
2484 # internal and external Application Load Balancers, external protocol
2485 # forwarding, and Classic VPN.
2486 # - Some products have restrictions on what ports can be used. See
2487 # port specifications for details.
2488 #
2489 #
2490 #
2491 # For external forwarding rules, two or more forwarding rules cannot use the
2492 # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
2493 #
2494 # For internal forwarding rules within the same VPC network, two or more
2495 # forwarding rules cannot use the same [IPAddress, IPProtocol]
2496 # pair, and cannot have overlapping portRanges.
2497 #
2498 # @pattern: \\d+(?:-\\d+)?
2499 &quot;ports&quot;: [ # The ports, portRange, and allPorts
2500 # fields are mutually exclusive. Only packets addressed to ports in the
2501 # specified range will be forwarded to the backends configured with this
2502 # forwarding rule.
2503 #
2504 # The ports field has the following limitations:
2505 #
2506 # - It requires that the forwarding rule IPProtocol be TCP,
2507 # UDP, or SCTP, and
2508 # - It&#x27;s applicable only to the following products: internal passthrough
2509 # Network Load Balancers, backend service-based external passthrough Network
2510 # Load Balancers, and internal protocol forwarding.
2511 # - You can specify a list of up to five ports by number, separated by
2512 # commas. The ports can be contiguous or discontiguous.
2513 #
2514 #
2515 #
2516 # For external forwarding rules, two or more forwarding rules cannot use the
2517 # same [IPAddress, IPProtocol] pair if they share at least one
2518 # port number.
2519 #
2520 # For internal forwarding rules within the same VPC network, two or more
2521 # forwarding rules cannot use the same [IPAddress, IPProtocol]
2522 # pair if they share at least one port number.
2523 #
2524 # @pattern: \\d+(?:-\\d+)?
2525 &quot;A String&quot;,
2526 ],
2527 &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
2528 &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
2529 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional forwarding rule resides.
2530 # This field is not applicable to global forwarding rules.
2531 # You must specify this field as part of the HTTP request URL. It is
2532 # not settable as a field in the request body.
2533 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2534 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2535 &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
2536 # Currently, only supports a single Service Directory resource.
2537 { # Describes the auto-registration of the forwarding rule to Service Directory.
2538 # The region and project of the Service Directory resource generated from
2539 # this registration will be the same as this forwarding rule.
2540 &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
2541 &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
2542 &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
2543 # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
2544 # All PSC for Google APIs forwarding rules on the same network should use
2545 # the same Service Directory region.
2546 },
2547 ],
2548 &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
2549 # If specified, the prefix is the first label of the fully qualified service
2550 # name.
2551 #
2552 # The label must be 1-63 characters long, and comply withRFC1035.
2553 # Specifically, the label must be 1-63 characters long and match the regular
2554 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2555 # character must be a lowercase letter, and all following characters must
2556 # be a dash, lowercase letter, or digit, except the last character, which
2557 # cannot be a dash.
2558 #
2559 # This field is only used for internal load balancing.
2560 &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
2561 # The internal fully qualified service name for this forwarding rule.
2562 #
2563 # This field is only used for internal load balancing.
2564 &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
2565 # source IP address matches one of the IP addresses or CIDR ranges set here.
2566 # Note that a forwarding rule can only have up to 64 source IP ranges, and
2567 # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
2568 # Each source_ip_range entry should be either an IP address (for
2569 # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
2570 &quot;A String&quot;,
2571 ],
2572 &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
2573 # belong to for this forwarding rule, used with internal load balancers and
2574 # external passthrough Network Load Balancers with IPv6.
2575 #
2576 # If the network specified is in auto subnet mode, this field is optional.
2577 # However, a subnetwork must be specified if the network is in custom subnet
2578 # mode or when creating external forwarding rule with IPv6.
2579 &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic. For
2580 # regional forwarding rules, this target must be in the same region as the
2581 # forwarding rule. For global forwarding rules, this target must be a global
2582 # load balancing resource.
2583 #
2584 # The forwarded traffic must be of a type appropriate to the target object.
2585 #
2586 #
2587 # - For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
2588 # - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
2589 #
2590 #
2591 # - vpc-sc - APIs that support VPC Service Controls.
2592 # - all-apis - All supported Google APIs.
2593 #
2594 #
2595 # - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
2596 },
2597 ],
2598 &quot;kind&quot;: &quot;compute#forwardingRuleList&quot;, # Output only. Type of resource.
2599 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2600 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2601 # the query parameter pageToken in the next list request.
2602 # Subsequent list requests will have their own nextPageToken to
2603 # continue paging through the results.
2604 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2605 &quot;warning&quot;: { # [Output Only] Informational warning message.
2606 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2607 # Engine returns NO_RESULTS_ON_PAGE if there
2608 # are no results in the response.
2609 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2610 # value format. For example:
2611 #
2612 # &quot;data&quot;: [
2613 # {
2614 # &quot;key&quot;: &quot;scope&quot;,
2615 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2616 # }
2617 {
2618 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2619 # returned. For example, for warnings where there are no results in a list
2620 # request for a particular zone, this key might be scope and
2621 # the key value might be the zone name. Other examples might be a key
2622 # indicating a deprecated resource and a suggested replacement, or a
2623 # warning about invalid network settings (for example, if an instance
2624 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2625 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2626 },
2627 ],
2628 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2629 },
2630 }</pre>
2631 </div>
2632
2633 <div class="method">
2634 <code class="details" id="list_next">list_next()</code>
2635 <pre>Retrieves the next page of results.
2636
2637 Args:
2638 previous_request: The request for the previous page. (required)
2639 previous_response: The response from the request for the previous page. (required)
2640
2641 Returns:
2642 A request object that you can call &#x27;execute()&#x27; on to request the next
2643 page. Returns None if there are no more items in the collection.
2644 </pre>
2645 </div>
2646
2647 <div class="method">
2648 <code class="details" id="patch">patch(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</code>
2649 <pre>Updates the specified forwarding rule with the data included in the
2650 request. This method supportsPATCH
2651 semantics and uses theJSON merge
2652 patch format and processing rules. Currently, you can only
2653 patch the network_tier field.
2654
2655 Args:
2656 project: string, Project ID for this request. (required)
2657 region: string, Name of the region scoping this request. (required)
2658 forwardingRule: string, Name of the ForwardingRule resource to patch. (required)
2659 body: object, The request body.
2660 The object takes the form of:
2661
2662 { # Represents a Forwarding Rule resource.
2663 #
2664 # Forwarding rule resources in Google Cloud can be either regional or global in
2665 # scope:
2666 #
2667 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
2668 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
2669 #
2670 # A forwarding rule and its corresponding IP address represent the frontend
2671 # configuration of a Google Cloud load balancer.
2672 # Forwarding rules can also reference target instances and Cloud VPN Classic
2673 # gateways (targetVpnGateway).
2674 #
2675 # For more information, read
2676 # Forwarding rule concepts and
2677 # Using protocol forwarding.
2678 &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
2679 # sends traffic to this IP address, the forwarding rule directs the traffic
2680 # to the referenced target or backendService.
2681 # While creating a forwarding rule, specifying an IPAddress is
2682 # required under the following circumstances:
2683 #
2684 #
2685 # - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
2686 # - When the target is a Private Service Connect Google APIs
2687 # bundle, you must specify an IPAddress.
2688 #
2689 #
2690 # Otherwise, you can optionally specify an IP address that references an
2691 # existing static (reserved) IP address resource. When omitted, Google Cloud
2692 # assigns an ephemeral IP address.
2693 #
2694 # Use one of the following formats to specify an IP address while creating a
2695 # forwarding rule:
2696 #
2697 # * IP address number, as in `100.1.2.3`
2698 # * IPv6 address range, as in `2600:1234::/96`
2699 # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
2700 # * Partial URL or by name, as in:
2701 #
2702 # - projects/project_id/regions/region/addresses/address-name
2703 # - regions/region/addresses/address-name
2704 # - global/addresses/address-name
2705 # - address-name
2706 #
2707 #
2708 #
2709 # The forwarding rule&#x27;s target or backendService,
2710 # and in most cases, also the loadBalancingScheme, determine the
2711 # type of IP address that you can use. For detailed information, see
2712 # [IP address
2713 # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
2714 #
2715 # When reading an IPAddress, the API always returns the IP
2716 # address number.
2717 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
2718 #
2719 # For protocol forwarding, valid
2720 # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
2721 #
2722 # The valid IP protocols are different for different load balancing products
2723 # as described in [Load balancing
2724 # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
2725 &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
2726 # fields are mutually exclusive. Only packets addressed to ports in the
2727 # specified range will be forwarded to the backends configured with this
2728 # forwarding rule.
2729 #
2730 # The allPorts field has the following limitations:
2731 #
2732 # - It requires that the forwarding rule IPProtocol be TCP,
2733 # UDP, SCTP, or L3_DEFAULT.
2734 # - It&#x27;s applicable only to the following products: internal passthrough
2735 # Network Load Balancers, backend service-based external passthrough Network
2736 # Load Balancers, and internal and external protocol forwarding.
2737 # - Set this field to true to allow packets addressed to any port or
2738 # packets lacking destination port information (for example, UDP fragments
2739 # after the first fragment) to be forwarded to the backends configured with
2740 # this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
2741 &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
2742 # Balancers, the regional internal Application Load Balancer, and the
2743 # regional internal proxy Network Load Balancer from all regions.
2744 # If false, only allows access from the local region the load balancer is
2745 # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
2746 # cannot be changed after the forwarding rule is created.
2747 &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
2748 # endpoint can be accessed from another region.
2749 &quot;attachedExtensions&quot;: [ # Output only. [Output Only]. The extensions that are attached to this ForwardingRule.
2750 { # Reference to an extension resource that is attached to this ForwardingRule.
2751 &quot;reference&quot;: &quot;A String&quot;, # Output only. The resource name.
2752 },
2753 ],
2754 &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
2755 # Required for internal and external passthrough Network Load Balancers;
2756 # must be omitted for all other load balancer types.
2757 &quot;baseForwardingRule&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the corresponding base forwarding rule. By base
2758 # forwarding rule, we mean the forwarding rule that has the same IP address,
2759 # protocol, and port settings with the current forwarding rule, but without
2760 # sourceIPRanges specified.
2761 # Always empty if the current forwarding rule does not have sourceIPRanges
2762 # specified.
2763 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2764 # text format.
2765 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2766 # create the resource.
2767 &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
2768 # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
2769 # TEST_ALL_TRAFFIC.
2770 #
2771 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
2772 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
2773 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
2774 # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
2775 # attached to this forwarding rule by percentage using
2776 # externalManagedBackendBucketMigrationTestingPercentage.
2777 #
2778 # Rolling back a migration requires the states to be set in reverse order. So
2779 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
2780 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
2781 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
2782 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
2783 &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
2784 # processed by the global external Application Load Balancer.
2785 #
2786 # The value of this field must be in the range [0, 100].
2787 #
2788 # This value can only be set if the loadBalancingScheme in the BackendService
2789 # is set to EXTERNAL (when using the classic Application Load Balancer) and
2790 # the migration state is TEST_BY_PERCENTAGE.
2791 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
2792 # This field is used in optimistic locking. This field will be ignored when
2793 # inserting a ForwardingRule. Include the fingerprint in patch request to
2794 # ensure that you do not overwrite changes that were applied from another
2795 # concurrent request.
2796 #
2797 # To see the latest fingerprint, make a get() request to
2798 # retrieve a ForwardingRule.
2799 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2800 # defined by the server.
2801 &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
2802 # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
2803 #
2804 # Use one of the following formats to specify a sub-PDP when creating an IPv6
2805 # NetLB forwarding rule using BYOIP:
2806 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
2807 # Partial URL, as in:
2808 #
2809 # - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
2810 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
2811 &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule. Valid options
2812 # are IPV4 or IPV6.
2813 &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
2814 # packet mirroring. To prevent mirroring loops, instances behind this
2815 # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
2816 # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
2817 &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
2818 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
2819 # essentially a hash of the labels set used for optimistic locking. The
2820 # fingerprint is initially generated by Compute Engine and changes after
2821 # every request to modify or update labels. You must always provide an
2822 # up-to-date fingerprint hash in order to update or change labels,
2823 # otherwise the request will fail with error412 conditionNotMet.
2824 #
2825 # To see the latest fingerprint, make a get() request to
2826 # retrieve a ForwardingRule.
2827 &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.
2828 # Label values may be empty.
2829 &quot;a_key&quot;: &quot;A String&quot;,
2830 },
2831 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
2832 #
2833 # For more information about forwarding rules, refer to
2834 # Forwarding rule concepts.
2835 &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
2836 # configuration to a limited set of xDS
2837 # compliant clients. In their xDS requests to load balancer, xDS clients
2838 # present node
2839 # metadata. When there is a match, the relevant configuration
2840 # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
2841 # referenced by the ForwardingRule are not visible to
2842 # those proxies.
2843 #
2844 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
2845 # the metadata. If its filterMatchCriteria is set to
2846 # MATCH_ALL, then all of its filterLabels must match with
2847 # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
2848 # in order to be considered a match.
2849 #
2850 # metadataFilters specified here will be applifed before
2851 # those specified in the UrlMap that thisForwardingRule references.
2852 #
2853 # metadataFilters only applies to Loadbalancers that have
2854 # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
2855 { # Opaque filter criteria used by load balancers to restrict routing
2856 # configuration to a limited set of load balancing proxies. Proxies and
2857 # sidecars involved in load balancing would typically present metadata to the
2858 # load balancers that need to match criteria specified here. If a match takes
2859 # place, the relevant configuration is made available to those
2860 # proxies.
2861 #
2862 # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
2863 # one of thefilterLabels must match the corresponding label provided in
2864 # the metadata. If its filterMatchCriteria is set to
2865 # MATCH_ALL, then all of its filterLabels must match with
2866 # corresponding labels provided in the metadata.
2867 #
2868 # An example for using metadataFilters would be: if
2869 # load balancing involves
2870 # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in of their XDS requests to loadbalancers.
2871 &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
2872 # metadata based on filterMatchCriteria
2873 #
2874 # This list must not be empty and can have at the most 64 entries.
2875 { # MetadataFilter label name value pairs that are expected
2876 # to match corresponding labels presented as metadata to the load balancer.
2877 &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
2878 #
2879 # The name can have a maximum length of 1024 characters and must be at
2880 # least 1 character long.
2881 &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
2882 #
2883 # value can have a maximum length of 1024 characters.
2884 },
2885 ],
2886 &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
2887 # within the list of filterLabels and contributes toward the
2888 # overall metadataFilter match.
2889 #
2890 # Supported values are:
2891 #
2892 # - MATCH_ANY: at least one of the filterLabels
2893 # must have a matching label in the provided metadata.
2894 # - MATCH_ALL: all filterLabels must have
2895 # matching labels in the provided metadata.
2896 },
2897 ],
2898 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
2899 # The name must be 1-63 characters long, and comply withRFC1035.
2900 # Specifically, the name must be 1-63 characters long and match the regular
2901 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2902 # character must be a lowercase letter, and all following characters must
2903 # be a dash, lowercase letter, or digit, except the last character, which
2904 # cannot be a dash.
2905 #
2906 # For Private Service Connect forwarding rules that forward traffic to Google
2907 # APIs, the forwarding rule name must be a 1-20 characters string with
2908 # lowercase letters and numbers and must start with a letter.
2909 &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
2910 #
2911 # For internal passthrough Network Load Balancers, this field identifies the
2912 # network that the load balanced IP should belong to for this forwarding
2913 # rule.
2914 # If the subnetwork is specified, the network of the subnetwork will be used.
2915 # If neither subnetwork nor this field is specified, the default network will
2916 # be used.
2917 #
2918 # For Private Service Connect forwarding rules that forward traffic to Google
2919 # APIs, a network must be provided.
2920 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
2921 # this load balancer and can only take the following values:PREMIUM, STANDARD.
2922 #
2923 # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
2924 #
2925 # If this field is not specified, it is assumed to be PREMIUM.
2926 # If IPAddress is specified, this value must be equal to the
2927 # networkTier of the Address.
2928 &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
2929 # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
2930 # this field. Once set, this field is not mutable.
2931 &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
2932 # fields are mutually exclusive. Only packets addressed to ports in the
2933 # specified range will be forwarded to the backends configured with this
2934 # forwarding rule.
2935 #
2936 # The portRange field has the following limitations:
2937 #
2938 # - It requires that the forwarding rule IPProtocol be TCP,
2939 # UDP, or SCTP, and
2940 # - It&#x27;s applicable only to the following products: external passthrough
2941 # Network Load Balancers, internal and external proxy Network Load Balancers,
2942 # internal and external Application Load Balancers, external protocol
2943 # forwarding, and Classic VPN.
2944 # - Some products have restrictions on what ports can be used. See
2945 # port specifications for details.
2946 #
2947 #
2948 #
2949 # For external forwarding rules, two or more forwarding rules cannot use the
2950 # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
2951 #
2952 # For internal forwarding rules within the same VPC network, two or more
2953 # forwarding rules cannot use the same [IPAddress, IPProtocol]
2954 # pair, and cannot have overlapping portRanges.
2955 #
2956 # @pattern: \\d+(?:-\\d+)?
2957 &quot;ports&quot;: [ # The ports, portRange, and allPorts
2958 # fields are mutually exclusive. Only packets addressed to ports in the
2959 # specified range will be forwarded to the backends configured with this
2960 # forwarding rule.
2961 #
2962 # The ports field has the following limitations:
2963 #
2964 # - It requires that the forwarding rule IPProtocol be TCP,
2965 # UDP, or SCTP, and
2966 # - It&#x27;s applicable only to the following products: internal passthrough
2967 # Network Load Balancers, backend service-based external passthrough Network
2968 # Load Balancers, and internal protocol forwarding.
2969 # - You can specify a list of up to five ports by number, separated by
2970 # commas. The ports can be contiguous or discontiguous.
2971 #
2972 #
2973 #
2974 # For external forwarding rules, two or more forwarding rules cannot use the
2975 # same [IPAddress, IPProtocol] pair if they share at least one
2976 # port number.
2977 #
2978 # For internal forwarding rules within the same VPC network, two or more
2979 # forwarding rules cannot use the same [IPAddress, IPProtocol]
2980 # pair if they share at least one port number.
2981 #
2982 # @pattern: \\d+(?:-\\d+)?
2983 &quot;A String&quot;,
2984 ],
2985 &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
2986 &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
2987 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional forwarding rule resides.
2988 # This field is not applicable to global forwarding rules.
2989 # You must specify this field as part of the HTTP request URL. It is
2990 # not settable as a field in the request body.
2991 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2992 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2993 &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
2994 # Currently, only supports a single Service Directory resource.
2995 { # Describes the auto-registration of the forwarding rule to Service Directory.
2996 # The region and project of the Service Directory resource generated from
2997 # this registration will be the same as this forwarding rule.
2998 &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
2999 &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
3000 &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
3001 # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
3002 # All PSC for Google APIs forwarding rules on the same network should use
3003 # the same Service Directory region.
3004 },
3005 ],
3006 &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
3007 # If specified, the prefix is the first label of the fully qualified service
3008 # name.
3009 #
3010 # The label must be 1-63 characters long, and comply withRFC1035.
3011 # Specifically, the label must be 1-63 characters long and match the regular
3012 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3013 # character must be a lowercase letter, and all following characters must
3014 # be a dash, lowercase letter, or digit, except the last character, which
3015 # cannot be a dash.
3016 #
3017 # This field is only used for internal load balancing.
3018 &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
3019 # The internal fully qualified service name for this forwarding rule.
3020 #
3021 # This field is only used for internal load balancing.
3022 &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
3023 # source IP address matches one of the IP addresses or CIDR ranges set here.
3024 # Note that a forwarding rule can only have up to 64 source IP ranges, and
3025 # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
3026 # Each source_ip_range entry should be either an IP address (for
3027 # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
3028 &quot;A String&quot;,
3029 ],
3030 &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
3031 # belong to for this forwarding rule, used with internal load balancers and
3032 # external passthrough Network Load Balancers with IPv6.
3033 #
3034 # If the network specified is in auto subnet mode, this field is optional.
3035 # However, a subnetwork must be specified if the network is in custom subnet
3036 # mode or when creating external forwarding rule with IPv6.
3037 &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic. For
3038 # regional forwarding rules, this target must be in the same region as the
3039 # forwarding rule. For global forwarding rules, this target must be a global
3040 # load balancing resource.
3041 #
3042 # The forwarded traffic must be of a type appropriate to the target object.
3043 #
3044 #
3045 # - For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
3046 # - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
3047 #
3048 #
3049 # - vpc-sc - APIs that support VPC Service Controls.
3050 # - all-apis - All supported Google APIs.
3051 #
3052 #
3053 # - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
3054 }
3055
3056 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3057 that if you must retry your request, the server will know to ignore the
3058 request if it has already been completed.
3059
3060 For example, consider a situation where you make an initial request and
3061 the request times out. If you make the request again with the same
3062 request ID, the server can check if original operation with the same
3063 request ID was received, and if so, will ignore the second request. This
3064 prevents clients from accidentally creating duplicate commitments.
3065
3066 The request ID must be
3067 a valid UUID with the exception that zero UUID is not supported
3068 (00000000-0000-0000-0000-000000000000).
3069 x__xgafv: string, V1 error format.
3070 Allowed values
3071 1 - v1 error format
3072 2 - v2 error format
3073
3074 Returns:
3075 An object of the form:
3076
3077 { # Represents an Operation resource.
3078 #
3079 # Google Compute Engine has three Operation resources:
3080 #
3081 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3082 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3083 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3084 #
3085 # You can use an operation resource to manage asynchronous API requests.
3086 # For more information, readHandling
3087 # API responses.
3088 #
3089 # Operations can be global, regional or zonal.
3090 #
3091 # - For global operations, use the `globalOperations`
3092 # resource.
3093 # - For regional operations, use the
3094 # `regionOperations` resource.
3095 # - For zonal operations, use
3096 # the `zoneOperations` resource.
3097 #
3098 #
3099 #
3100 # For more information, read
3101 # Global, Regional, and Zonal Resources.
3102 #
3103 # Note that completed Operation resources have a limited
3104 # retention period.
3105 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3106 # Not present otherwise.
3107 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3108 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3109 # set when the operation is created.
3110 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3111 # text format.
3112 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3113 # this field will be populated.
3114 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3115 # operation.
3116 {
3117 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3118 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3119 # details. There is a set of defined message types to use for providing
3120 # details.The syntax depends on the error code. For example,
3121 # QuotaExceededInfo will have details when the error code is
3122 # QUOTA_EXCEEDED.
3123 {
3124 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3125 #
3126 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3127 # is not enabled:
3128 #
3129 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3130 # &quot;domain&quot;: &quot;googleapis.com&quot;
3131 # &quot;metadata&quot;: {
3132 # &quot;resource&quot;: &quot;projects/123&quot;,
3133 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3134 # }
3135 # }
3136 #
3137 # This response indicates that the pubsub.googleapis.com API is not enabled.
3138 #
3139 # Example of an error that is returned when attempting to create a Spanner
3140 # instance in a region that is out of stock:
3141 #
3142 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3143 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3144 # &quot;metadata&quot;: {
3145 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3146 # }
3147 # }
3148 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3149 # is typically the registered service name of the tool or product that
3150 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3151 # generated by some common infrastructure, the error domain must be a
3152 # globally unique value that identifies the infrastructure. For Google API
3153 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3154 &quot;metadatas&quot;: { # Additional structured details about this error.
3155 #
3156 # Keys must match a regular expression of `a-z+` but should
3157 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3158 # length. When identifying the current value of an exceeded limit, the units
3159 # should be contained in the key, not the value. For example, rather than
3160 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3161 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3162 # instances that can be created in a single (batch) request.
3163 &quot;a_key&quot;: &quot;A String&quot;,
3164 },
3165 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3166 # proximate cause of the error. Error reasons are unique within a particular
3167 # domain of errors. This should be at most 63 characters and match a
3168 # regular expression of `A-Z+[A-Z0-9]`, which represents
3169 # UPPER_SNAKE_CASE.
3170 },
3171 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3172 #
3173 # For example, if a quota check failed with an error indicating the calling
3174 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3175 # directly to the right place in the developer console to flip the bit.
3176 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3177 { # Describes a URL link.
3178 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3179 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3180 },
3181 ],
3182 },
3183 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3184 # which can be attached to an RPC error.
3185 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3186 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3187 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3188 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3189 },
3190 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3191 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3192 &quot;a_key&quot;: &quot;A String&quot;,
3193 },
3194 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3195 # type or metric.
3196 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3197 # or metric.
3198 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3199 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3200 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3201 },
3202 },
3203 ],
3204 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3205 # This property is optional.
3206 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3207 },
3208 ],
3209 },
3210 &quot;getVersionOperationMetadata&quot;: {
3211 &quot;inlineSbomInfo&quot;: {
3212 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3213 # appropriate identifiers.
3214 &quot;a_key&quot;: &quot;A String&quot;,
3215 },
3216 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3217 # identifiers.
3218 &quot;a_key&quot;: &quot;A String&quot;,
3219 },
3220 },
3221 },
3222 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3223 # message that was returned, such as `NOT FOUND`.
3224 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3225 # status code that was returned. For example, a `404` means the
3226 # resource was not found.
3227 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3228 # defined by the server.
3229 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3230 # This value is inRFC3339
3231 # text format.
3232 &quot;instancesBulkInsertOperationMetadata&quot;: {
3233 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3234 # Example key: zones/us-central1-a
3235 &quot;a_key&quot;: {
3236 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3237 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3238 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3239 # error.
3240 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3241 # if the flow is rolling forward or rolling back.
3242 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3243 },
3244 },
3245 },
3246 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3247 # Operation resources.
3248 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3249 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3250 # group of operations results from a `bulkInsert` API request.
3251 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3252 # `update`, or `delete`, and so on.
3253 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3254 # There is no requirement that this be linear or support any granularity of
3255 # operations. This should not be used to guess when the operation will be
3256 # complete. This number should monotonically increase as the operation
3257 # progresses.
3258 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3259 # applicable when performing regional operations.
3260 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3261 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3262 # this field will contain information on all underlying zonal actions and
3263 # their state.
3264 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3265 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3266 # Example key: zones/us-central1-a
3267 &quot;a_key&quot;: {
3268 &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
3269 # populated.
3270 # different programming environments, including REST APIs and RPC APIs. It is
3271 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3272 # three pieces of data: error code, error message, and error details.
3273 #
3274 # You can find out more about this error model and how to work with it in the
3275 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3276 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3277 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3278 # message types for APIs to use.
3279 {
3280 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3281 },
3282 ],
3283 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3284 # user-facing error message should be localized and sent in the
3285 # google.rpc.Status.details field, or localized by the client.
3286 },
3287 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3288 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3289 },
3290 },
3291 },
3292 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3293 # This value is inRFC3339
3294 # text format.
3295 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3296 # following:
3297 # `PENDING`, `RUNNING`, or `DONE`.
3298 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3299 # operation.
3300 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3301 # of the target resource.
3302 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3303 # operations related to creating a snapshot, this points to the disk
3304 # that the snapshot was created from.
3305 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3306 # `[email protected]` or
3307 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3308 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3309 # operation, this field will be populated.
3310 {
3311 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3312 # Engine returns NO_RESULTS_ON_PAGE if there
3313 # are no results in the response.
3314 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3315 # value format. For example:
3316 #
3317 # &quot;data&quot;: [
3318 # {
3319 # &quot;key&quot;: &quot;scope&quot;,
3320 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3321 # }
3322 {
3323 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3324 # returned. For example, for warnings where there are no results in a list
3325 # request for a particular zone, this key might be scope and
3326 # the key value might be the zone name. Other examples might be a key
3327 # indicating a deprecated resource and a suggested replacement, or a
3328 # warning about invalid network settings (for example, if an instance
3329 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3330 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3331 },
3332 ],
3333 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3334 },
3335 ],
3336 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3337 # applicable when performing per-zone operations.
3338 }</pre>
3339 </div>
3340
3341 <div class="method">
3342 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
3343 <pre>Sets the labels on the specified resource. To learn more about labels,
3344 read the
3345 Labeling Resources documentation.
3346
3347 Args:
3348 project: string, Project ID for this request. (required)
3349 region: string, The region for this request. (required)
3350 resource: string, Name or id of the resource for this request. (required)
3351 body: object, The request body.
3352 The object takes the form of:
3353
3354 {
3355 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
3356 # used to detect conflicts. The fingerprint is initially generated by Compute
3357 # Engine and changes after every request to modify or update labels. You must
3358 # always provide an up-to-date fingerprint hash in order to update or change
3359 # labels. Make a get() request to the resource to get the latest
3360 # fingerprint.
3361 &quot;labels&quot;: { # The labels to set for this resource.
3362 &quot;a_key&quot;: &quot;A String&quot;,
3363 },
3364 }
3365
3366 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3367 that if you must retry your request, the server will know to ignore the
3368 request if it has already been completed.
3369
3370 For example, consider a situation where you make an initial request and
3371 the request times out. If you make the request again with the same
3372 request ID, the server can check if original operation with the same
3373 request ID was received, and if so, will ignore the second request. This
3374 prevents clients from accidentally creating duplicate commitments.
3375
3376 The request ID must be
3377 a valid UUID with the exception that zero UUID is not supported
3378 (00000000-0000-0000-0000-000000000000).
3379 x__xgafv: string, V1 error format.
3380 Allowed values
3381 1 - v1 error format
3382 2 - v2 error format
3383
3384 Returns:
3385 An object of the form:
3386
3387 { # Represents an Operation resource.
3388 #
3389 # Google Compute Engine has three Operation resources:
3390 #
3391 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3392 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3393 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3394 #
3395 # You can use an operation resource to manage asynchronous API requests.
3396 # For more information, readHandling
3397 # API responses.
3398 #
3399 # Operations can be global, regional or zonal.
3400 #
3401 # - For global operations, use the `globalOperations`
3402 # resource.
3403 # - For regional operations, use the
3404 # `regionOperations` resource.
3405 # - For zonal operations, use
3406 # the `zoneOperations` resource.
3407 #
3408 #
3409 #
3410 # For more information, read
3411 # Global, Regional, and Zonal Resources.
3412 #
3413 # Note that completed Operation resources have a limited
3414 # retention period.
3415 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3416 # Not present otherwise.
3417 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3418 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3419 # set when the operation is created.
3420 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3421 # text format.
3422 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3423 # this field will be populated.
3424 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3425 # operation.
3426 {
3427 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3428 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3429 # details. There is a set of defined message types to use for providing
3430 # details.The syntax depends on the error code. For example,
3431 # QuotaExceededInfo will have details when the error code is
3432 # QUOTA_EXCEEDED.
3433 {
3434 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3435 #
3436 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3437 # is not enabled:
3438 #
3439 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3440 # &quot;domain&quot;: &quot;googleapis.com&quot;
3441 # &quot;metadata&quot;: {
3442 # &quot;resource&quot;: &quot;projects/123&quot;,
3443 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3444 # }
3445 # }
3446 #
3447 # This response indicates that the pubsub.googleapis.com API is not enabled.
3448 #
3449 # Example of an error that is returned when attempting to create a Spanner
3450 # instance in a region that is out of stock:
3451 #
3452 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3453 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3454 # &quot;metadata&quot;: {
3455 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3456 # }
3457 # }
3458 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3459 # is typically the registered service name of the tool or product that
3460 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3461 # generated by some common infrastructure, the error domain must be a
3462 # globally unique value that identifies the infrastructure. For Google API
3463 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3464 &quot;metadatas&quot;: { # Additional structured details about this error.
3465 #
3466 # Keys must match a regular expression of `a-z+` but should
3467 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3468 # length. When identifying the current value of an exceeded limit, the units
3469 # should be contained in the key, not the value. For example, rather than
3470 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3471 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3472 # instances that can be created in a single (batch) request.
3473 &quot;a_key&quot;: &quot;A String&quot;,
3474 },
3475 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3476 # proximate cause of the error. Error reasons are unique within a particular
3477 # domain of errors. This should be at most 63 characters and match a
3478 # regular expression of `A-Z+[A-Z0-9]`, which represents
3479 # UPPER_SNAKE_CASE.
3480 },
3481 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3482 #
3483 # For example, if a quota check failed with an error indicating the calling
3484 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3485 # directly to the right place in the developer console to flip the bit.
3486 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3487 { # Describes a URL link.
3488 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3489 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3490 },
3491 ],
3492 },
3493 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3494 # which can be attached to an RPC error.
3495 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3496 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3497 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3498 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3499 },
3500 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3501 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3502 &quot;a_key&quot;: &quot;A String&quot;,
3503 },
3504 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3505 # type or metric.
3506 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3507 # or metric.
3508 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3509 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3510 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3511 },
3512 },
3513 ],
3514 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3515 # This property is optional.
3516 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3517 },
3518 ],
3519 },
3520 &quot;getVersionOperationMetadata&quot;: {
3521 &quot;inlineSbomInfo&quot;: {
3522 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3523 # appropriate identifiers.
3524 &quot;a_key&quot;: &quot;A String&quot;,
3525 },
3526 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3527 # identifiers.
3528 &quot;a_key&quot;: &quot;A String&quot;,
3529 },
3530 },
3531 },
3532 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3533 # message that was returned, such as `NOT FOUND`.
3534 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3535 # status code that was returned. For example, a `404` means the
3536 # resource was not found.
3537 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3538 # defined by the server.
3539 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3540 # This value is inRFC3339
3541 # text format.
3542 &quot;instancesBulkInsertOperationMetadata&quot;: {
3543 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3544 # Example key: zones/us-central1-a
3545 &quot;a_key&quot;: {
3546 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3547 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3548 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3549 # error.
3550 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3551 # if the flow is rolling forward or rolling back.
3552 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3553 },
3554 },
3555 },
3556 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3557 # Operation resources.
3558 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3559 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3560 # group of operations results from a `bulkInsert` API request.
3561 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3562 # `update`, or `delete`, and so on.
3563 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3564 # There is no requirement that this be linear or support any granularity of
3565 # operations. This should not be used to guess when the operation will be
3566 # complete. This number should monotonically increase as the operation
3567 # progresses.
3568 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3569 # applicable when performing regional operations.
3570 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3571 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3572 # this field will contain information on all underlying zonal actions and
3573 # their state.
3574 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3575 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3576 # Example key: zones/us-central1-a
3577 &quot;a_key&quot;: {
3578 &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
3579 # populated.
3580 # different programming environments, including REST APIs and RPC APIs. It is
3581 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3582 # three pieces of data: error code, error message, and error details.
3583 #
3584 # You can find out more about this error model and how to work with it in the
3585 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3586 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3587 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3588 # message types for APIs to use.
3589 {
3590 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3591 },
3592 ],
3593 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3594 # user-facing error message should be localized and sent in the
3595 # google.rpc.Status.details field, or localized by the client.
3596 },
3597 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3598 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3599 },
3600 },
3601 },
3602 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3603 # This value is inRFC3339
3604 # text format.
3605 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3606 # following:
3607 # `PENDING`, `RUNNING`, or `DONE`.
3608 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3609 # operation.
3610 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3611 # of the target resource.
3612 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3613 # operations related to creating a snapshot, this points to the disk
3614 # that the snapshot was created from.
3615 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3616 # `[email protected]` or
3617 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3618 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3619 # operation, this field will be populated.
3620 {
3621 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3622 # Engine returns NO_RESULTS_ON_PAGE if there
3623 # are no results in the response.
3624 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3625 # value format. For example:
3626 #
3627 # &quot;data&quot;: [
3628 # {
3629 # &quot;key&quot;: &quot;scope&quot;,
3630 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3631 # }
3632 {
3633 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3634 # returned. For example, for warnings where there are no results in a list
3635 # request for a particular zone, this key might be scope and
3636 # the key value might be the zone name. Other examples might be a key
3637 # indicating a deprecated resource and a suggested replacement, or a
3638 # warning about invalid network settings (for example, if an instance
3639 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3640 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3641 },
3642 ],
3643 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3644 },
3645 ],
3646 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3647 # applicable when performing per-zone operations.
3648 }</pre>
3649 </div>
3650
3651 <div class="method">
3652 <code class="details" id="setTarget">setTarget(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</code>
3653 <pre>Changes target URL for forwarding rule. The new target should be of the
3654 same type as the old target.
3655
3656 Args:
3657 project: string, Project ID for this request. (required)
3658 region: string, Name of the region scoping this request. (required)
3659 forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
3660 body: object, The request body.
3661 The object takes the form of:
3662
3663 {
3664 &quot;target&quot;: &quot;A String&quot;,
3665 }
3666
3667 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3668 that if you must retry your request, the server will know to ignore the
3669 request if it has already been completed.
3670
3671 For example, consider a situation where you make an initial request and
3672 the request times out. If you make the request again with the same
3673 request ID, the server can check if original operation with the same
3674 request ID was received, and if so, will ignore the second request. This
3675 prevents clients from accidentally creating duplicate commitments.
3676
3677 The request ID must be
3678 a valid UUID with the exception that zero UUID is not supported
3679 (00000000-0000-0000-0000-000000000000).
3680 x__xgafv: string, V1 error format.
3681 Allowed values
3682 1 - v1 error format
3683 2 - v2 error format
3684
3685 Returns:
3686 An object of the form:
3687
3688 { # Represents an Operation resource.
3689 #
3690 # Google Compute Engine has three Operation resources:
3691 #
3692 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3693 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3694 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3695 #
3696 # You can use an operation resource to manage asynchronous API requests.
3697 # For more information, readHandling
3698 # API responses.
3699 #
3700 # Operations can be global, regional or zonal.
3701 #
3702 # - For global operations, use the `globalOperations`
3703 # resource.
3704 # - For regional operations, use the
3705 # `regionOperations` resource.
3706 # - For zonal operations, use
3707 # the `zoneOperations` resource.
3708 #
3709 #
3710 #
3711 # For more information, read
3712 # Global, Regional, and Zonal Resources.
3713 #
3714 # Note that completed Operation resources have a limited
3715 # retention period.
3716 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3717 # Not present otherwise.
3718 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3719 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3720 # set when the operation is created.
3721 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3722 # text format.
3723 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3724 # this field will be populated.
3725 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3726 # operation.
3727 {
3728 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3729 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3730 # details. There is a set of defined message types to use for providing
3731 # details.The syntax depends on the error code. For example,
3732 # QuotaExceededInfo will have details when the error code is
3733 # QUOTA_EXCEEDED.
3734 {
3735 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3736 #
3737 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3738 # is not enabled:
3739 #
3740 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3741 # &quot;domain&quot;: &quot;googleapis.com&quot;
3742 # &quot;metadata&quot;: {
3743 # &quot;resource&quot;: &quot;projects/123&quot;,
3744 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3745 # }
3746 # }
3747 #
3748 # This response indicates that the pubsub.googleapis.com API is not enabled.
3749 #
3750 # Example of an error that is returned when attempting to create a Spanner
3751 # instance in a region that is out of stock:
3752 #
3753 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3754 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3755 # &quot;metadata&quot;: {
3756 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3757 # }
3758 # }
3759 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3760 # is typically the registered service name of the tool or product that
3761 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3762 # generated by some common infrastructure, the error domain must be a
3763 # globally unique value that identifies the infrastructure. For Google API
3764 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3765 &quot;metadatas&quot;: { # Additional structured details about this error.
3766 #
3767 # Keys must match a regular expression of `a-z+` but should
3768 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3769 # length. When identifying the current value of an exceeded limit, the units
3770 # should be contained in the key, not the value. For example, rather than
3771 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3772 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3773 # instances that can be created in a single (batch) request.
3774 &quot;a_key&quot;: &quot;A String&quot;,
3775 },
3776 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3777 # proximate cause of the error. Error reasons are unique within a particular
3778 # domain of errors. This should be at most 63 characters and match a
3779 # regular expression of `A-Z+[A-Z0-9]`, which represents
3780 # UPPER_SNAKE_CASE.
3781 },
3782 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3783 #
3784 # For example, if a quota check failed with an error indicating the calling
3785 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3786 # directly to the right place in the developer console to flip the bit.
3787 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3788 { # Describes a URL link.
3789 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3790 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3791 },
3792 ],
3793 },
3794 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3795 # which can be attached to an RPC error.
3796 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3797 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3798 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3799 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3800 },
3801 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3802 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3803 &quot;a_key&quot;: &quot;A String&quot;,
3804 },
3805 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3806 # type or metric.
3807 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3808 # or metric.
3809 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3810 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3811 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3812 },
3813 },
3814 ],
3815 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3816 # This property is optional.
3817 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3818 },
3819 ],
3820 },
3821 &quot;getVersionOperationMetadata&quot;: {
3822 &quot;inlineSbomInfo&quot;: {
3823 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3824 # appropriate identifiers.
3825 &quot;a_key&quot;: &quot;A String&quot;,
3826 },
3827 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3828 # identifiers.
3829 &quot;a_key&quot;: &quot;A String&quot;,
3830 },
3831 },
3832 },
3833 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3834 # message that was returned, such as `NOT FOUND`.
3835 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3836 # status code that was returned. For example, a `404` means the
3837 # resource was not found.
3838 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3839 # defined by the server.
3840 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3841 # This value is inRFC3339
3842 # text format.
3843 &quot;instancesBulkInsertOperationMetadata&quot;: {
3844 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3845 # Example key: zones/us-central1-a
3846 &quot;a_key&quot;: {
3847 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3848 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3849 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3850 # error.
3851 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3852 # if the flow is rolling forward or rolling back.
3853 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3854 },
3855 },
3856 },
3857 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3858 # Operation resources.
3859 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3860 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3861 # group of operations results from a `bulkInsert` API request.
3862 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3863 # `update`, or `delete`, and so on.
3864 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3865 # There is no requirement that this be linear or support any granularity of
3866 # operations. This should not be used to guess when the operation will be
3867 # complete. This number should monotonically increase as the operation
3868 # progresses.
3869 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3870 # applicable when performing regional operations.
3871 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3872 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3873 # this field will contain information on all underlying zonal actions and
3874 # their state.
3875 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3876 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3877 # Example key: zones/us-central1-a
3878 &quot;a_key&quot;: {
3879 &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
3880 # populated.
3881 # different programming environments, including REST APIs and RPC APIs. It is
3882 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3883 # three pieces of data: error code, error message, and error details.
3884 #
3885 # You can find out more about this error model and how to work with it in the
3886 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3887 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3888 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3889 # message types for APIs to use.
3890 {
3891 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3892 },
3893 ],
3894 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3895 # user-facing error message should be localized and sent in the
3896 # google.rpc.Status.details field, or localized by the client.
3897 },
3898 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3899 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3900 },
3901 },
3902 },
3903 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3904 # This value is inRFC3339
3905 # text format.
3906 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3907 # following:
3908 # `PENDING`, `RUNNING`, or `DONE`.
3909 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3910 # operation.
3911 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3912 # of the target resource.
3913 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3914 # operations related to creating a snapshot, this points to the disk
3915 # that the snapshot was created from.
3916 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3917 # `[email protected]` or
3918 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3919 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3920 # operation, this field will be populated.
3921 {
3922 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3923 # Engine returns NO_RESULTS_ON_PAGE if there
3924 # are no results in the response.
3925 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3926 # value format. For example:
3927 #
3928 # &quot;data&quot;: [
3929 # {
3930 # &quot;key&quot;: &quot;scope&quot;,
3931 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3932 # }
3933 {
3934 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3935 # returned. For example, for warnings where there are no results in a list
3936 # request for a particular zone, this key might be scope and
3937 # the key value might be the zone name. Other examples might be a key
3938 # indicating a deprecated resource and a suggested replacement, or a
3939 # warning about invalid network settings (for example, if an instance
3940 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3941 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3942 },
3943 ],
3944 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3945 },
3946 ],
3947 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3948 # applicable when performing per-zone operations.
3949 }</pre>
3950 </div>
3951
3952 </body></html>