Debian Codegraph @

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