Debian Codegraph @

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