Debian Codegraph @

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