Debian Codegraph @

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