Debian Codegraph @

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