Debian Codegraph @

docs/dyn/compute_beta.regionBackendServices.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionBackendServices.html">regionBackendServices</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, region, backendService, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified regional BackendService resource.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, region, backendService, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified regional BackendService resource.</p>
86 <p class="toc_element">
87 <code><a href="#getHealth">getHealth(project, region, backendService, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the most recent health check results for this</p>
89 <p class="toc_element">
90 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
92 <p class="toc_element">
93 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Creates a regional BackendService resource in the specified project using</p>
95 <p class="toc_element">
96 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Retrieves the list of regional BackendService resources available to the</p>
98 <p class="toc_element">
99 <code><a href="#listUsable">listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves a list of all usable backend services in the specified project in</p>
101 <p class="toc_element">
102 <code><a href="#listUsable_next">listUsable_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#list_next">list_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#patch">patch(project, region, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Updates the specified regional BackendService resource with the data</p>
110 <p class="toc_element">
111 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the access control policy on the specified resource.</p>
113 <p class="toc_element">
114 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, region, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Sets the Google Cloud Armor security policy for the specified backend</p>
116 <p class="toc_element">
117 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
119 <p class="toc_element">
120 <code><a href="#update">update(project, region, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Updates the specified regional BackendService resource with the data</p>
122 <h3>Method Details</h3>
123 <div class="method">
124 <code class="details" id="close">close()</code>
125 <pre>Close httplib2 connections.</pre>
126 </div>
127
128 <div class="method">
129 <code class="details" id="delete">delete(project, region, backendService, requestId=None, x__xgafv=None)</code>
130 <pre>Deletes the specified regional BackendService resource.
131
132 Args:
133 project: string, Project ID for this request. (required)
134 region: string, Name of the region scoping this request. (required)
135 backendService: string, Name of the BackendService resource to delete. (required)
136 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
137 that if you must retry your request, the server will know to ignore the
138 request if it has already been completed.
139
140 For example, consider a situation where you make an initial request and
141 the request times out. If you make the request again with the same
142 request ID, the server can check if original operation with the same
143 request ID was received, and if so, will ignore the second request. This
144 prevents clients from accidentally creating duplicate commitments.
145
146 The request ID must be
147 a valid UUID with the exception that zero UUID is not supported
148 (00000000-0000-0000-0000-000000000000).
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154 Returns:
155 An object of the form:
156
157 { # Represents an Operation resource.
158 #
159 # Google Compute Engine has three Operation resources:
160 #
161 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
162 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
163 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
164 #
165 # You can use an operation resource to manage asynchronous API requests.
166 # For more information, readHandling
167 # API responses.
168 #
169 # Operations can be global, regional or zonal.
170 #
171 # - For global operations, use the `globalOperations`
172 # resource.
173 # - For regional operations, use the
174 # `regionOperations` resource.
175 # - For zonal operations, use
176 # the `zoneOperations` resource.
177 #
178 #
179 #
180 # For more information, read
181 # Global, Regional, and Zonal Resources.
182 #
183 # Note that completed Operation resources have a limited
184 # retention period.
185 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
186 # Not present otherwise.
187 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
188 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
189 # set when the operation is created.
190 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
191 # text format.
192 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
193 # this field will be populated.
194 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
195 # operation.
196 {
197 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
198 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
199 # details. There is a set of defined message types to use for providing
200 # details.The syntax depends on the error code. For example,
201 # QuotaExceededInfo will have details when the error code is
202 # QUOTA_EXCEEDED.
203 {
204 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
205 #
206 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
207 # is not enabled:
208 #
209 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
210 # &quot;domain&quot;: &quot;googleapis.com&quot;
211 # &quot;metadata&quot;: {
212 # &quot;resource&quot;: &quot;projects/123&quot;,
213 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
214 # }
215 # }
216 #
217 # This response indicates that the pubsub.googleapis.com API is not enabled.
218 #
219 # Example of an error that is returned when attempting to create a Spanner
220 # instance in a region that is out of stock:
221 #
222 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
223 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
224 # &quot;metadata&quot;: {
225 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
226 # }
227 # }
228 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
229 # is typically the registered service name of the tool or product that
230 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
231 # generated by some common infrastructure, the error domain must be a
232 # globally unique value that identifies the infrastructure. For Google API
233 # infrastructure, the error domain is &quot;googleapis.com&quot;.
234 &quot;metadatas&quot;: { # Additional structured details about this error.
235 #
236 # Keys must match a regular expression of `a-z+` but should
237 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
238 # length. When identifying the current value of an exceeded limit, the units
239 # should be contained in the key, not the value. For example, rather than
240 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
241 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
242 # instances that can be created in a single (batch) request.
243 &quot;a_key&quot;: &quot;A String&quot;,
244 },
245 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
246 # proximate cause of the error. Error reasons are unique within a particular
247 # domain of errors. This should be at most 63 characters and match a
248 # regular expression of `A-Z+[A-Z0-9]`, which represents
249 # UPPER_SNAKE_CASE.
250 },
251 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
252 #
253 # For example, if a quota check failed with an error indicating the calling
254 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
255 # directly to the right place in the developer console to flip the bit.
256 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
257 { # Describes a URL link.
258 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
259 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
260 },
261 ],
262 },
263 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
264 # which can be attached to an RPC error.
265 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
266 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
267 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
268 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
269 },
270 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
271 &quot;dimensions&quot;: { # The map holding related quota dimensions.
272 &quot;a_key&quot;: &quot;A String&quot;,
273 },
274 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
275 # type or metric.
276 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
277 # or metric.
278 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
279 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
280 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
281 },
282 },
283 ],
284 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
285 # This property is optional.
286 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
287 },
288 ],
289 },
290 &quot;getVersionOperationMetadata&quot;: {
291 &quot;inlineSbomInfo&quot;: {
292 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
293 # appropriate identifiers.
294 &quot;a_key&quot;: &quot;A String&quot;,
295 },
296 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
297 # identifiers.
298 &quot;a_key&quot;: &quot;A String&quot;,
299 },
300 },
301 },
302 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
303 # message that was returned, such as `NOT FOUND`.
304 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
305 # status code that was returned. For example, a `404` means the
306 # resource was not found.
307 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
308 # defined by the server.
309 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
310 # This value is inRFC3339
311 # text format.
312 &quot;instancesBulkInsertOperationMetadata&quot;: {
313 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
314 # Example key: zones/us-central1-a
315 &quot;a_key&quot;: {
316 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
317 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
318 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
319 # error.
320 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
321 # if the flow is rolling forward or rolling back.
322 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
323 },
324 },
325 },
326 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
327 # Operation resources.
328 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
329 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
330 # group of operations results from a `bulkInsert` API request.
331 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
332 # `update`, or `delete`, and so on.
333 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
334 # There is no requirement that this be linear or support any granularity of
335 # operations. This should not be used to guess when the operation will be
336 # complete. This number should monotonically increase as the operation
337 # progresses.
338 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
339 # applicable when performing regional operations.
340 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
341 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
342 # this field will contain information on all underlying zonal actions and
343 # their state.
344 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
345 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
346 # Example key: zones/us-central1-a
347 &quot;a_key&quot;: {
348 &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
349 # populated.
350 # different programming environments, including REST APIs and RPC APIs. It is
351 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
352 # three pieces of data: error code, error message, and error details.
353 #
354 # You can find out more about this error model and how to work with it in the
355 # [API Design Guide](https://cloud.google.com/apis/design/errors).
356 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
357 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
358 # message types for APIs to use.
359 {
360 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
361 },
362 ],
363 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
364 # user-facing error message should be localized and sent in the
365 # google.rpc.Status.details field, or localized by the client.
366 },
367 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
368 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
369 },
370 },
371 },
372 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
373 # This value is inRFC3339
374 # text format.
375 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
376 # following:
377 # `PENDING`, `RUNNING`, or `DONE`.
378 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
379 # operation.
380 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
381 # of the target resource.
382 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
383 # operations related to creating a snapshot, this points to the disk
384 # that the snapshot was created from.
385 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
386 # `[email protected]` or
387 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
388 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
389 # operation, this field will be populated.
390 {
391 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
392 # Engine returns NO_RESULTS_ON_PAGE if there
393 # are no results in the response.
394 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
395 # value format. For example:
396 #
397 # &quot;data&quot;: [
398 # {
399 # &quot;key&quot;: &quot;scope&quot;,
400 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
401 # }
402 {
403 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
404 # returned. For example, for warnings where there are no results in a list
405 # request for a particular zone, this key might be scope and
406 # the key value might be the zone name. Other examples might be a key
407 # indicating a deprecated resource and a suggested replacement, or a
408 # warning about invalid network settings (for example, if an instance
409 # attempts to perform IP forwarding but is not enabled for IP forwarding).
410 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
411 },
412 ],
413 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
414 },
415 ],
416 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
417 # applicable when performing per-zone operations.
418 }</pre>
419 </div>
420
421 <div class="method">
422 <code class="details" id="get">get(project, region, backendService, x__xgafv=None)</code>
423 <pre>Returns the specified regional BackendService resource.
424
425 Args:
426 project: string, Project ID for this request. (required)
427 region: string, Name of the region scoping this request. (required)
428 backendService: string, Name of the BackendService resource to return. (required)
429 x__xgafv: string, V1 error format.
430 Allowed values
431 1 - v1 error format
432 2 - v2 error format
433
434 Returns:
435 An object of the form:
436
437 { # Represents a Backend Service resource.
438 #
439 # A backend service defines how Google Cloud load balancers distribute traffic.
440 # The backend service configuration contains a set of values, such as the
441 # protocol used to connect to backends, various distribution and session
442 # settings, health checks, and timeouts. These settings provide fine-grained
443 # control over how your load balancer behaves. Most of the settings have
444 # default values that allow for easy configuration if you need to get started
445 # quickly.
446 #
447 # Backend services in Google Compute Engine can be either regionally or
448 # globally scoped.
449 #
450 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
451 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
452 #
453 # For more information, seeBackend
454 # Services.
455 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
456 # Load Balancers and Traffic Director and requires
457 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
458 #
459 # If set to 0, the cookie is non-persistent and lasts only until
460 # the end of the browser session (or equivalent). The maximum allowed value
461 # is two weeks (1,209,600).
462 #
463 # Not supported when the backend service is referenced by a URL map that is
464 # bound to target gRPC proxy that has validateForProxyless field set to true.
465 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
466 { # Message containing information of one individual backend.
467 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
468 # handle additional traffic or is fully loaded. For usage guidelines, see
469 # Connection balancing mode.
470 #
471 # Backends must use compatible balancing modes. For more information, see
472 # Supported balancing modes and target capacity settings and
473 # Restrictions and guidance for instance groups.
474 #
475 # Note: Currently, if you use the API to configure incompatible balancing
476 # modes, the configuration might be accepted even though it has no impact
477 # and is ignored. Specifically, Backend.maxUtilization is ignored when
478 # Backend.balancingMode is RATE. In the future, this incompatible combination
479 # will be rejected.
480 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
481 # mode.
482 # The default value is 1, which means the group serves up to
483 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
484 # completely drained, offering 0% of its available capacity. The valid ranges
485 # are 0.0 and [0.1,1.0].
486 # You cannot configure a setting larger than 0 and smaller than0.1.
487 # You cannot configure a setting of 0 when there is only one
488 # backend attached to the backend service.
489 #
490 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
491 # internet NEGs, regional serverless NEGs, and PSC NEGs.
492 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
493 # BalancingMode.
494 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
495 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
496 # Monitoring, but is not used for load balancing.
497 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
498 # balancing mode. The valid range is [0.0, 1.0].
499 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
500 # long and match the regular expression
501 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
502 # first character must be a lowercase letter, and all following
503 # characters must be a dash, period, underscore, lowercase letter, or
504 # digit, except the last character, which cannot be a dash, period, or
505 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
506 # field can only be used for a global or regional backend service with the
507 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
508 },
509 ],
510 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
511 # create the resource.
512 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
513 # failover backend can be configured for a given BackendService.
514 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
515 # group or network endpoint
516 # group (NEG) resource. To determine what types of backends a load
517 # balancer supports, see the [Backend services
518 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
519 #
520 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
521 # or NEG. Partial URLs are not supported.
522 #
523 # If haPolicy is specified, backends must refer to NEG resources of type
524 # GCE_VM_IP.
525 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
526 # guidelines, seeConnection
527 # balancing mode and Utilization
528 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
529 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
530 # guidelines, seeConnection
531 # balancing mode and Utilization
532 # balancing mode.
533 #
534 # Not available if the backend&#x27;s balancingMode isRATE.
535 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
536 # For usage guidelines, seeConnection
537 # balancing mode and Utilization
538 # balancing mode.
539 #
540 # Not available if the backend&#x27;s balancingMode isRATE.
541 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
542 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
543 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
544 # Not available if backend&#x27;s balancingMode is RATE
545 # or CONNECTION.
546 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
547 # Not available if backend&#x27;s balancingMode is RATE
548 # or CONNECTION.
549 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
550 # usage guidelines, seeRate
551 # balancing mode and Utilization
552 # balancing mode.
553 #
554 # Not available if the backend&#x27;s balancingMode isCONNECTION.
555 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
556 # guidelines, seeRate
557 # balancing mode and Utilization
558 # balancing mode.
559 #
560 # Not available if the backend&#x27;s balancingMode isCONNECTION.
561 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
562 # guidelines, seeRate
563 # balancing mode and Utilization
564 # balancing mode.
565 #
566 # Not available if the backend&#x27;s balancingMode isCONNECTION.
567 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
568 #
569 # For usage guidelines, seeUtilization
570 # balancing mode.
571 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
572 # the backend.
573 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
574 },
575 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
576 # sending traffic to backends with default preference. The possible values
577 # are:
578 #
579 # - PREFERRED: Backends with this preference level will be
580 # filled up to their capacity limits first, based on RTT.
581 # - DEFAULT: If preferred backends don&#x27;t have enough
582 # capacity, backends in this layer would be used and traffic would be
583 # assigned based on the load balancing algorithm you use. This is the
584 # default
585 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
586 # Attachment).
587 # e.g.
588 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
589 # for Cloud Run service.
590 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
591 # for PSC Service Attachment.
592 &quot;trafficDuration&quot;: &quot;A String&quot;,
593 },
594 ],
595 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
596 # specified load balancer types.
597 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
598 # Pragma or Authorization headers. Up to 5 headers can be specified.
599 # The cache is bypassed for all cdnPolicy.cacheMode settings.
600 { # Bypass the cache when the specified request headers are present,
601 # e.g. Pragma or Authorization headers. Values are case insensitive.
602 # The presence of such a header overrides the cache_mode setting.
603 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
604 # Values are case-insensitive.
605 },
606 ],
607 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
608 # CDN.
609 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
610 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
611 &quot;A String&quot;,
612 ],
613 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
614 # The name=value pair will be used in the cache key Cloud CDN generates.
615 &quot;A String&quot;,
616 ],
617 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
618 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
619 # query_string_whitelist and query_string_blacklist. If neither is set, the
620 # entire query string will be included. If false, the query string will be
621 # excluded from the cache key entirely.
622 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
623 # parameters will be included. Either specify query_string_whitelist or
624 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
625 # not treated as delimiters.
626 &quot;A String&quot;,
627 ],
628 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
629 # parameters will be excluded. Either specify query_string_whitelist or
630 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
631 # not treated as delimiters.
632 &quot;A String&quot;,
633 ],
634 },
635 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
636 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
637 # headers to cache content. Responses without these headers will not be
638 # cached at Google&#x27;s edge, and will require a full trip to the origin on
639 # every request, potentially impacting performance and increasing load on
640 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
641 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
642 # Warning: this may result in Cloud CDN caching private,
643 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
644 # including common image formats, media (video and audio), and web assets
645 # (JavaScript and CSS). Requests and responses that are marked as
646 # uncacheable, as well as dynamic content (including HTML), will not be
647 # cached.
648 #
649 # If no value is provided for cdnPolicy.cacheMode, it defaults
650 # to CACHE_ALL_STATIC.
651 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
652 # used to clamp the max-age (or Expires) value sent to the client. With
653 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
654 # response max-age directive, along with a &quot;public&quot; directive. For
655 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
656 # from the origin (if specified), or else sets the response max-age
657 # directive to the lesser of the client_ttl and default_ttl, and also
658 # ensures a &quot;public&quot; cache-control directive is present.
659 # If a client TTL is not specified, a default value (1 hour) will be used.
660 # The maximum allowed value is 31,622,400s (1 year).
661 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
662 # responses that do not have an existing valid TTL (max-age or s-maxage).
663 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
664 # The value of defaultTTL cannot be set to a value greater than that of
665 # maxTTL, but can be equal.
666 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
667 # will overwrite the TTL set in all responses. The maximum allowed value is
668 # 31,622,400s (1 year), noting that infrequently accessed objects may be
669 # evicted from the cache before the defined TTL.
670 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
671 # origin.
672 # Cache directives that attempt to set a max-age or s-maxage higher than
673 # this, or an Expires header more than maxTTL seconds in the future will
674 # be capped at the value of maxTTL, as if it were the value of an
675 # s-maxage Cache-Control directive.
676 # Headers sent to the client will not be modified.
677 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
678 # The maximum allowed value is 31,622,400s (1 year), noting that
679 # infrequently accessed objects may be evicted from the cache before
680 # the defined TTL.
681 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
682 # to apply fine-grained caching for common errors or redirects.
683 # This can reduce the load on your origin and improve end-user
684 # experience by reducing response latency.
685 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
686 # negative caching applies to responses with the specified response code
687 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
688 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
689 # to all responses with the specified response code, and override any
690 # caching headers.
691 # By default, Cloud CDN will apply the following default TTLs to these
692 # status codes:
693 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
694 # HTTP 404 (Not Found), 410 (Gone),
695 # 451 (Unavailable For Legal Reasons): 120s
696 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
697 # These defaults can be overridden in negative_caching_policy.
698 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
699 # negative_caching must be enabled to configure negative_caching_policy.
700 # Omitting the policy and leaving negative_caching enabled will use
701 # Cloud CDN&#x27;s default cache TTLs.
702 # Note that when specifying an explicit negative_caching_policy, you
703 # should take care to specify a cache TTL for all response codes
704 # that you wish to cache. Cloud CDN will not apply any default
705 # negative caching when a policy exists.
706 { # Specify CDN TTLs for response error codes.
707 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
708 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
709 # specified as values, and you cannot specify a status code more than
710 # once.
711 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
712 # corresponding status code.
713 # The maximum allowed value is 1800s (30 minutes), noting that
714 # infrequently accessed objects may be evicted from the cache before the
715 # defined TTL.
716 },
717 ],
718 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
719 # requests into a small number of requests to the origin.
720 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
721 # content with the origin, or when an error is encountered when refreshing
722 # the cache.
723 # This setting defines the default &quot;max-stale&quot; duration for any cached
724 # responses that do not specify a max-stale directive. Stale responses that
725 # exceed the TTL configured here will not be served. The default limit
726 # (max-stale) is 86400s (1 day), which will allow stale content to be
727 # served up to this limit beyond the max-age (or s-maxage) of a cached
728 # response.
729 # The maximum allowed value is 604800 (1 week).
730 # Set this to zero (0) to disable serve-while-stale.
731 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
732 # considered fresh. After this time period, the response will be
733 # revalidated before being served. Defaults to 1hr (3600s). When serving
734 # responses to signed URL requests, Cloud CDN will internally behave as
735 # though all responses from this backend had a &quot;Cache-Control:
736 # public, max-age=[TTL]&quot; header, regardless of any existing
737 # Cache-Control header. The actual headers served in responses will not be
738 # altered.
739 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
740 &quot;A String&quot;,
741 ],
742 },
743 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
744 # backend service.
745 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
746 # as a count of seconds and fractions of seconds at nanosecond
747 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
748 # or &quot;month&quot;. Range is approximately 10,000 years.
749 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
750 # Durations less than one second are represented with a 0
751 # `seconds` field and a positive `nanos` field. Must be from 0
752 # to 999,999,999 inclusive.
753 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
754 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
755 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
756 },
757 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
758 # there is no limit.
759 #
760 # Not supported when the backend service is referenced by a URL map that is
761 # bound to target gRPC proxy that has validateForProxyless field set to true.
762 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
763 # not specified, there is no limit.
764 #
765 # Not supported when the backend service is referenced by a URL map that is
766 # bound to target gRPC proxy that has validateForProxyless field set to true.
767 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
768 # service. If not specified, there is no limit.
769 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
770 # This parameter is respected by both the HTTP/1.1 and HTTP/2
771 # implementations. If not specified, there is no limit. Setting this
772 # parameter to 1 will effectively disable keep alive.
773 #
774 # Not supported when the backend service is referenced by a URL map that is
775 # bound to target gRPC proxy that has validateForProxyless field set to true.
776 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
777 # not specified, the default is 1.
778 #
779 # Not supported when the backend service is referenced by a URL map that is
780 # bound to target gRPC proxy that has validateForProxyless field set to true.
781 },
782 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
783 # the client&#x27;s Accept-Encoding header.
784 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
785 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
786 # instance. For supported load balancers and protocols, as described inEnabling
787 # connection draining.
788 },
789 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
790 # tracking policy settings are only available for external passthrough
791 # Network Load Balancers and internal passthrough Network Load Balancers.
792 #
793 # connectionTrackingPolicy cannot be specified with haPolicy.
794 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
795 # value is DEFAULT_FOR_PROTOCOL.
796 #
797 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
798 # persist on unhealthy backends only for connection-oriented protocols
799 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
800 # Affinity is configured for 5-tuple. They do not persist forUDP.
801 #
802 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
803 # the existing connections on the unhealthy backend are never persisted on
804 # the unhealthy backend. They are always diverted to newly selected healthy
805 # backends (unless all backends are unhealthy).
806 #
807 # If set to ALWAYS_PERSIST, existing connections always
808 # persist on unhealthy backends regardless of protocol and session
809 # affinity. It is generally not recommended to use this mode overriding the
810 # default.
811 #
812 # For more details, see [Connection Persistence for Network Load
813 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
814 # and [Connection Persistence for Internal TCP/UDP Load
815 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
816 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
817 # Balancers. This option is not available publicly.
818 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
819 # matching traffic (in seconds).
820 #
821 # For internal passthrough Network Load Balancers:
822 #
823 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
824 # - It can be set only if Connection Tracking is less than 5-tuple
825 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
826 # Mode is PER_SESSION).
827 #
828 #
829 #
830 # For external passthrough Network Load Balancers the default is 60
831 # seconds. This option is not available publicly.
832 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
833 # options:
834 #
835 # - PER_CONNECTION: This is the default mode. The Connection
836 # Tracking is performed as per the Connection Key (default Hash Method) for
837 # the specific protocol.
838 # - PER_SESSION: The Connection Tracking is performed as per
839 # the configured Session Affinity. It matches the configured Session
840 # Affinity.
841 #
842 #
843 #
844 # For more details, see [Tracking Mode for Network Load
845 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
846 # and [Tracking Mode for Internal TCP/UDP Load
847 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
848 },
849 &quot;consistentHash&quot;: { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session
850 # affinity based on HTTP headers, cookies or other properties. This load
851 # balancing policy is applicable only for HTTP connections. The affinity to a
852 # particular destination host will be lost when one or more hosts are
853 # added/removed from the destination service. This field specifies parameters
854 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
855 #
856 # This field is applicable to either:
857 #
858 # - A regional backend service with the service protocol set to HTTP,
859 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
860 # INTERNAL_MANAGED.
861 # - A global backend service with the
862 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
863 &quot;httpCookie&quot;: { # The information about the HTTP Cookie on which the hash function is based # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
864 # be used as the hash key for the consistent hash load balancer. If the
865 # cookie is not present, it will be generated. This field is applicable if
866 # the sessionAffinity is set to HTTP_COOKIE.
867 #
868 # Not supported when the backend service is referenced by a URL map that is
869 # bound to target gRPC proxy that has validateForProxyless field set to true.
870 # for load balancing policies that use a consistent hash.
871 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
872 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
873 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
874 # as a count of seconds and fractions of seconds at nanosecond
875 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
876 # or &quot;month&quot;. Range is approximately 10,000 years.
877 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
878 # Durations less than one second are represented with a 0
879 # `seconds` field and a positive `nanos` field. Must be from 0
880 # to 999,999,999 inclusive.
881 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
882 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
883 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
884 },
885 },
886 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
887 # applicable if the sessionAffinity is set toHEADER_FIELD.
888 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
889 # 1024. Larger ring sizes result in more granular load distributions. If the
890 # number of hosts in the load balancing pool is larger than the ring size,
891 # each host will be assigned a single virtual node.
892 },
893 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
894 # text format.
895 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
896 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
897 # locality_lb_policy.
898 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
899 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
900 # long and match the regular expression
901 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
902 # first character must be a lowercase letter, and all following
903 # characters must be a dash, period, underscore, lowercase letter, or
904 # digit, except the last character, which cannot be a dash, period, or
905 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
906 # field can only be used for a global or regional backend service with the
907 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
908 },
909 ],
910 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
911 # custom
912 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
913 &quot;A String&quot;,
914 ],
915 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
916 # custom
917 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
918 &quot;A String&quot;,
919 ],
920 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
921 # create the resource.
922 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
923 # backend service with dynamic forwarding feature which together with Service
924 # Extension allows customized and complex routing logic.
925 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
926 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
927 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
928 },
929 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
930 # service. Some ranges are restricted: Restricted
931 # ranges.
932 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
933 },
934 },
935 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
936 # this backend service.
937 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
938 # global external Application Load Balancer.
939 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
940 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
941 #
942 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
943 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
944 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
945 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
946 # externalManagedMigrationTestingPercentage.
947 #
948 # Rolling back a migration requires the states to be set in reverse order. So
949 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
950 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
951 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
952 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
953 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
954 # external Application Load Balancer.
955 #
956 # The value of this field must be in the range [0, 100].
957 #
958 # Session affinity options will slightly affect this routing behavior, for
959 # more details, see:Session
960 # Affinity.
961 #
962 # This value can only be set if the loadBalancingScheme in the BackendService
963 # is set to EXTERNAL (when using the classic Application Load Balancer) and
964 # the migration state is TEST_BY_PERCENTAGE.
965 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
966 # as a backup (failover) backend.
967 # For load balancers that have configurable failover:
968 # [Internal passthrough Network Load
969 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
970 # and [external passthrough Network Load
971 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
972 #
973 # failoverPolicy cannot be specified with haPolicy.
974 # failover:
975 # [Internal passthrough Network Load
976 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
977 # and [external passthrough
978 # Network Load
979 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
980 # On failover or failback, this field indicates whether connection draining
981 # will be honored. Google Cloud has a fixed connection draining timeout of
982 # 10 minutes. A setting of true terminates existing TCP
983 # connections to the active pool during failover and failback, immediately
984 # draining traffic. A setting of false allows existing TCP
985 # connections to persist, even on VMs no longer in the active pool, for up
986 # to the duration of the connection draining timeout (10 minutes).
987 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
988 #
989 # The default is false.
990 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
991 # load balancer are dropped when all primary and all backup backend VMs are
992 # unhealthy.If set to false, connections are distributed
993 # among all primary VMs when all primary and all backup backend VMs are
994 # unhealthy.
995 # For load balancers that have configurable
996 # failover:
997 # [Internal passthrough
998 # Network Load
999 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1000 # and [external passthrough
1001 # Network Load
1002 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1003 # The default is false.
1004 &quot;failoverRatio&quot;: 3.14, # The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
1005 # failover when the number of healthy primary VMs equals zero.
1006 # For all other values, the load balancer performs a failover when the
1007 # total number of healthy primary VMs is less than this ratio.
1008 # For load balancers that have configurable
1009 # failover:
1010 # [Internal TCP/UDP Load
1011 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1012 # and [external TCP/UDP Load
1013 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1014 },
1015 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1016 # This field is used in optimistic locking. This field will be ignored when
1017 # inserting a BackendService. An up-to-date fingerprint must be provided in
1018 # order to update the BackendService, otherwise the request will
1019 # fail with error 412 conditionNotMet.
1020 #
1021 # To see the latest fingerprint, make a get() request to
1022 # retrieve a BackendService.
1023 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
1024 # Protocol Forwarding.
1025 #
1026 # The backends of this regional backend service must only specify zonal
1027 # network endpoint groups (NEGs) of type GCE_VM_IP.
1028 #
1029 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
1030 # regional backend service must set the network field. All zonal NEGs must
1031 # belong to the same network. However, individual NEGs can
1032 # belong to different subnetworks of that network.
1033 #
1034 # When haPolicy is specified, the set of attached network endpoints across
1035 # all backends comprise an High Availability domain from which one endpoint
1036 # is selected as the active endpoint (the leader) that receives all
1037 # traffic.
1038 #
1039 # haPolicy can be added only at backend service creation time. Once set up,
1040 # it cannot be deleted.
1041 #
1042 # Note that haPolicy is not for load balancing, and therefore cannot be
1043 # specified with sessionAffinity, connectionTrackingPolicy, and
1044 # failoverPolicy.
1045 #
1046 # haPolicy requires customers to be responsible for tracking backend
1047 # endpoint health and electing a leader among the healthy endpoints.
1048 # Therefore, haPolicy cannot be specified with healthChecks.
1049 #
1050 # haPolicy can only be specified for External Passthrough Network Load
1051 # Balancers and Internal Passthrough Network Load Balancers.
1052 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
1053 # achieve it.
1054 #
1055 # Supported values are:
1056 #
1057 # - DISABLED: Fast IP Move is disabled. You can only use the
1058 # haPolicy.leader API to update the leader.
1059 # - &gt;GARP_RA: Provides a method to very quickly define a new network
1060 # endpoint as the leader. This method is faster than updating the leader
1061 # using the haPolicy.leader API. Fast IP move works as follows: The VM
1062 # hosting the network endpoint that should become the new leader sends
1063 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
1064 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
1065 # temporarily associates the forwarding rule IP address with that VM, and
1066 # both new and in-flight packets are quickly delivered to that VM.
1067 #
1068 #
1069 #
1070 # Note the important properties of the Fast IP Move functionality:
1071 #
1072 # - The GARP/RA-initiated re-routing stays active for approximately 20
1073 # minutes. After triggering fast failover, you must also
1074 # appropriately set the haPolicy.leader.
1075 # - The new leader instance should continue to send GARP/RA packets
1076 # periodically every 10 seconds until at least 10 minutes after updating
1077 # the haPolicy.leader (but stop immediately if it is no longer the leader).
1078 # - After triggering a fast failover, we recommend that you wait at least
1079 # 3 seconds before sending another GARP/RA packet from a different VM
1080 # instance to avoid race conditions.
1081 # - Don&#x27;t send GARP/RA packets from different VM
1082 # instances at the same time. If multiple instances continue to send
1083 # GARP/RA packets, traffic might be routed to different destinations in an
1084 # alternating order. This condition ceases when a single instance
1085 # issues a GARP/RA packet.
1086 # - The GARP/RA request always takes priority over the leader API.
1087 # Using the haPolicy.leader API to change the leader to a different
1088 # instance will have no effect until the GARP/RA request becomes
1089 # inactive.
1090 # - The GARP/RA packets should follow the GARP/RA
1091 # Packet Specifications..
1092 # - When multiple forwarding rules refer to a regional backend service,
1093 # you need only send a GARP or RA packet for a single forwarding rule
1094 # virtual IP. The virtual IPs for all forwarding rules targeting the same
1095 # backend service will also be moved to the sender of the GARP or RA
1096 # packet.
1097 #
1098 #
1099 #
1100 # The following are the Fast IP Move limitations (that is, when fastIPMove
1101 # is not DISABLED):
1102 #
1103 # - Multiple forwarding rules cannot use the same IP address if one of
1104 # them refers to a regional backend service with fastIPMove.
1105 # - The regional backend service must set the network field, and all
1106 # NEGs must belong to that network. However, individual
1107 # NEGs can belong to different subnetworks of that network.
1108 # - The maximum number of network endpoints across all backends of a
1109 # backend service with fastIPMove is 32.
1110 # - The maximum number of backend services with fastIPMove that can have
1111 # the same network endpoint attached to one of its backends is 64.
1112 # - The maximum number of backend services with fastIPMove in a VPC in a
1113 # region is 64.
1114 # - The network endpoints that are attached to a backend of a backend
1115 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
1116 # - Traffic directed to the leader by a static route next hop will not be
1117 # redirected to a new leader by fast failover. Such traffic will only be
1118 # redirected once an haPolicy.leader update has taken effect. Only traffic
1119 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
1120 # fast failover.
1121 #
1122 #
1123 # haPolicy.fastIPMove can be set only at backend service creation time.
1124 # Once set, it cannot be updated.
1125 #
1126 # By default, fastIpMove is set to DISABLED.
1127 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
1128 # this service as the active endpoint (the leader) that receives all
1129 # traffic.
1130 #
1131 # When the leader changes, there is no connection draining to persist
1132 # existing connections on the old leader.
1133 #
1134 # You are responsible for selecting a suitable endpoint as the
1135 # leader. For example, preferring a healthy endpoint over unhealthy ones.
1136 # Note that this service does not track backend endpoint health, and
1137 # selects the configured leader unconditionally.
1138 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
1139 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
1140 # that the leader is attached to.
1141 #
1142 # The leader&#x27;s backendGroup must already be specified as a backend of
1143 # this backend service. Removing a backend that is designated as the
1144 # leader&#x27;s backendGroup is not permitted.
1145 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
1146 # designated as the leader.
1147 #
1148 # This network endpoint cannot be detached from the NEG specified in
1149 # the haPolicy.leader.backendGroup until the leader is updated with
1150 # another network endpoint, or the leader is removed from the haPolicy.
1151 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
1152 # instance must already be attached to the NEG specified in the
1153 # haPolicy.leader.backendGroup.
1154 #
1155 # The name must be 1-63 characters long, and comply with RFC1035.
1156 # Authorization requires the following IAM permission on the
1157 # specified resource instance: compute.instances.use
1158 },
1159 },
1160 },
1161 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
1162 # httpsHealthChecks (legacy) resource for health checking this backend
1163 # service. Not all backend services support legacy health checks. See
1164 # Load balancer guide. Currently, at most one health check can be
1165 # specified for each backend service. Backend services with
1166 # instance group or zonal NEG backends must have a health check unless
1167 # haPolicy is specified. Backend services with internet or serverless NEG
1168 # backends must not have a health check.
1169 #
1170 # healthChecks[] cannot be specified with haPolicy.
1171 &quot;A String&quot;,
1172 ],
1173 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
1174 # Not available for internal passthrough Network Load Balancers and external
1175 # passthrough Network Load Balancers.
1176 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
1177 # incoming requests.
1178 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
1179 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
1180 # For security reasons, this value cannot be retrieved via the API.
1181 # Instead, the SHA-256 hash of the value is returned in the
1182 # oauth2ClientSecretSha256 field.
1183 #
1184 # @InputOnly
1185 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
1186 },
1187 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1188 # defined by the server.
1189 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
1190 # from the client to the backend for proxyless gRPC).
1191 # The possible values are:
1192 #
1193 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
1194 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1195 # Group), regardless of traffic from the client to the proxy. Only IPv4
1196 # health checks are used to check the health of the backends. This is the
1197 # default setting.
1198 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
1199 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
1200 # address).
1201 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
1202 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1203 # Group), regardless of traffic from the client to the proxy. Only IPv6
1204 # health checks are used to check the health of the backends.
1205 #
1206 #
1207 #
1208 # This field is applicable to either:
1209 #
1210 # - Advanced global external Application Load Balancer (load balancing
1211 # scheme EXTERNAL_MANAGED),
1212 # - Regional external Application Load
1213 # Balancer,
1214 # - Internal proxy Network Load Balancer (load balancing
1215 # scheme INTERNAL_MANAGED),
1216 # - Regional internal Application Load
1217 # Balancer (load balancing scheme INTERNAL_MANAGED),
1218 # - Traffic
1219 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
1220 # INTERNAL_SELF_MANAGED).
1221 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
1222 # for backend services.
1223 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
1224 # created for one type of load balancer cannot be used with another.
1225 # For more information, refer toChoosing
1226 # a load balancer.
1227 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
1228 # preference. When you use localityLbPolicies, you must set at least one
1229 # value for either the localityLbPolicies[].policy or the
1230 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
1231 # value set in the localityLbPolicy field.
1232 #
1233 # For an example of how to use this field, seeDefine
1234 # a list of preferred policies.
1235 #
1236 # Caution: This field and its children are intended for use in a service mesh
1237 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
1238 # that have this configuration.
1239 { # Container for either a built-in LB policy supported by gRPC or Envoy or
1240 # a custom one implemented by the end user.
1241 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
1242 # deployed with the client.
1243 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
1244 # by a locally installed custom policy implementation.
1245 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
1246 #
1247 # The value should match the name of a custom implementation registered
1248 # on the gRPC clients. It should follow protocol buffer message naming
1249 # conventions and include the full path (for example,
1250 # myorg.CustomLbPolicy). The maximum length is 256 characters.
1251 #
1252 # Do not specify the same custom policy more than once for a
1253 # backend. If you do, the configuration is rejected.
1254 #
1255 # For an example of how to use this field, seeUse
1256 # a custom policy.
1257 },
1258 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
1259 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
1260 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
1261 # about these values, see the description of localityLbPolicy.
1262 #
1263 # Do not specify the same policy more than once for a
1264 # backend. If you do, the configuration is rejected.
1265 },
1266 },
1267 ],
1268 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
1269 # possible values are:
1270 #
1271 # - ROUND_ROBIN: This is a simple policy in which each healthy
1272 # backend is selected in round robin order. This is the default.
1273 # - LEAST_REQUEST: An O(1) algorithm which
1274 # selects two random healthy hosts and picks the host which has fewer active
1275 # requests.
1276 # - RING_HASH: The ring/modulo hash load balancer implements
1277 # consistent hashing to backends. The algorithm has the property that the
1278 # addition/removal of a host from a set of N hosts only affects 1/N of the
1279 # requests.
1280 # - RANDOM: The load balancer selects a random healthy
1281 # host.
1282 # - ORIGINAL_DESTINATION: Backend host is selected
1283 # based on the client connection metadata, i.e., connections are opened to
1284 # the same address as the destination address of the incoming connection
1285 # before the connection was redirected to the load balancer.
1286 # - MAGLEV: used as a drop in replacement for the ring hash
1287 # load balancer. Maglev is not as stable as ring hash but has faster table
1288 # lookup build times and host selection times. For more information about
1289 # Maglev, see Maglev:
1290 # A Fast and Reliable Software Network Load Balancer.
1291 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
1292 # Load Balancing using weights computed from Backend reported Custom Metrics.
1293 # If set, the Backend Service responses are expected to contain non-standard
1294 # HTTP response header field Endpoint-Load-Metrics. The reported
1295 # metrics to use for computing the weights are specified via thecustomMetrics field.
1296 #
1297 # This field is applicable to either:
1298 # - A regional backend service with the service protocol set to HTTP,
1299 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
1300 # INTERNAL_MANAGED.
1301 # - A global backend service with the
1302 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
1303 # EXTERNAL_MANAGED.
1304 #
1305 #
1306 # If sessionAffinity is not configured—that is, if session
1307 # affinity remains at the default value of NONE—then the
1308 # default value for localityLbPolicy
1309 # is ROUND_ROBIN. If session affinity is set to a value other
1310 # than NONE,
1311 # then the default value for localityLbPolicy isMAGLEV.
1312 #
1313 # Only ROUND_ROBIN and RING_HASH are supported
1314 # when the backend service is referenced by a URL map that is bound to
1315 # target gRPC proxy that has validateForProxyless field set to true.
1316 #
1317 # localityLbPolicy cannot be specified with haPolicy.
1318 &quot;logConfig&quot;: { # The available logging options for the load balancer traffic served by this # This field denotes the logging options for the load balancer traffic served
1319 # by this backend service. If logging is enabled, logs will be exported to
1320 # Stackdriver.
1321 # backend service.
1322 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
1323 # traffic served by this backend service. The default value is false.
1324 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
1325 { # Determines which HTTP headers will be logged to Stackdriver.
1326 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1327 },
1328 ],
1329 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
1330 { # Determines which HTTP headers will be logged to Stackdriver.
1331 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1332 },
1333 ],
1334 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
1335 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
1336 # of optional fields you want to include in the logs. For example:
1337 # serverInstance, serverGkeDetails.cluster,
1338 # serverGkeDetails.pod.podNamespace
1339 &quot;A String&quot;,
1340 ],
1341 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
1342 # service. Configures whether all, none or a subset of optional fields
1343 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1344 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1345 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
1346 # service. The value of the field must be in [0, 1]. This configures the
1347 # sampling rate of requests to the load balancer where 1.0 means all logged
1348 # requests are reported and 0.0 means no logged requests are reported. The
1349 # default value is 1.0.
1350 },
1351 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
1352 # service. Duration is computed from the beginning of the stream until the
1353 # response has been completely processed, including all retries. A stream
1354 # that does not complete in this duration is closed.
1355 #
1356 # If not specified, there will be no timeout limit, i.e. the maximum
1357 # duration is infinite.
1358 #
1359 # This value can be overridden in the PathMatcher configuration of the
1360 # UrlMap that references this backend service.
1361 #
1362 # This field is only allowed when the loadBalancingScheme of
1363 # the backend service is INTERNAL_SELF_MANAGED.
1364 # as a count of seconds and fractions of seconds at nanosecond
1365 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1366 # or &quot;month&quot;. Range is approximately 10,000 years.
1367 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1368 # Durations less than one second are represented with a 0
1369 # `seconds` field and a positive `nanos` field. Must be from 0
1370 # to 999,999,999 inclusive.
1371 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1372 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1373 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1374 },
1375 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
1376 # controller and read by the backend RCTH
1377 &quot;a_key&quot;: &quot;A String&quot;,
1378 },
1379 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1380 # The name must be 1-63 characters long, and comply withRFC1035.
1381 # Specifically, the name must be 1-63 characters long and match the regular
1382 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1383 # character must be a lowercase letter, and all following characters must
1384 # be a dash, lowercase letter, or digit, except the last character, which
1385 # cannot be a dash.
1386 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
1387 #
1388 # This field must be set for Internal Passthrough Network Load Balancers when
1389 # the haPolicy is enabled, and for External Passthrough Network Load
1390 # Balancers when the haPolicy fastIpMove is enabled.
1391 #
1392 # This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
1393 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
1394 # Load Balancers.
1395 #
1396 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
1397 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
1398 # endpoints in the local zone.
1399 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
1400 # possible values are:
1401 #
1402 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
1403 # is disabled. The load balancer distributes new connections to all
1404 # healthy backend endpoints across all zones.
1405 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
1406 # enabled. The load balancer distributes new connections to all healthy
1407 # backend endpoints in the local zone only. If there are no healthy
1408 # backend endpoints in the local zone, the load balancer distributes
1409 # new connections to all backend endpoints in the local zone.
1410 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
1411 # enabled. The load balancer distributes new connections to all healthy
1412 # backend endpoints in the local zone only. If there aren&#x27;t enough
1413 # healthy backend endpoints in the local zone, the load balancer
1414 # distributes new connections to all healthy backend endpoints across all
1415 # zones.
1416 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
1417 # of healthy backend endpoints in a zone to the count of backend
1418 # endpoints in that same zone is equal to or above this threshold, the
1419 # load balancer distributes new connections to all healthy endpoints in
1420 # the local zone only. When the ratio of the count of healthy backend
1421 # endpoints in a zone to the count of backend endpoints in that same
1422 # zone is below this threshold, the load balancer distributes all new
1423 # connections to all healthy endpoints across all zones.
1424 },
1425 },
1426 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
1427 # the backend service.
1428 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
1429 # service.
1430 },
1431 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
1432 # load balancing pool of each individual proxy instance that processes the
1433 # traffic for the given backend service. If not set, this feature is
1434 # considered disabled.
1435 #
1436 # Results of the outlier detection algorithm (ejection of endpoints from the
1437 # load balancing pool and returning them back to the pool) are executed
1438 # independently by each proxy instance of the load balancer. In most cases,
1439 # more than one proxy instance handles the traffic received by a backend
1440 # service. Thus, it is possible that an unhealthy endpoint is detected and
1441 # ejected by only some of the proxies, and while this happens, other proxies
1442 # may continue to send requests to the same unhealthy endpoint until they
1443 # detect and eject the unhealthy endpoint.
1444 #
1445 # Applicable backend endpoints can be:
1446 #
1447 # - VM instances in an Instance Group
1448 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
1449 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
1450 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
1451 # Functions Services
1452 # - Private Service Connect NEGs, that resolve to
1453 # Google-managed regional API endpoints or managed services published using
1454 # Private Service Connect
1455 #
1456 #
1457 #
1458 # Applicable backend service types can be:
1459 #
1460 # - A global backend service with the loadBalancingScheme set to
1461 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
1462 # - A regional backend
1463 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
1464 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
1465 # supported for Serverless NEGs.
1466 #
1467 #
1468 #
1469 # Not supported when the backend service is referenced by a URL map that is
1470 # bound to target gRPC proxy that has validateForProxyless field set to true.
1471 # pool for the backend service.
1472 &quot;baseEjectionTime&quot;: { # A Duration represents a fixed-length span of time represented # The base time that a backend endpoint is ejected for. Defaults to 30000ms
1473 # or 30s.
1474 #
1475 # After a backend endpoint is returned back to the load balancing pool, it
1476 # can be ejected again in another ejection analysis. Thus, the total ejection
1477 # time is equal to the base ejection time multiplied by the number of times
1478 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
1479 # as a count of seconds and fractions of seconds at nanosecond
1480 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1481 # or &quot;month&quot;. Range is approximately 10,000 years.
1482 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1483 # Durations less than one second are represented with a 0
1484 # `seconds` field and a positive `nanos` field. Must be from 0
1485 # to 999,999,999 inclusive.
1486 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1487 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1488 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1489 },
1490 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
1491 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
1492 # return code qualifies as an error. Defaults to 5.
1493 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
1494 # connection errors that are mapped to one of those status codes) before a
1495 # consecutive gateway failure ejection occurs. Defaults to 3.
1496 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1497 # outlier status is detected through consecutive 5xx. This setting can be
1498 # used to disable ejection or to ramp it up slowly. Defaults to 0.
1499 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1500 # outlier status is detected through consecutive gateway failures. This
1501 # setting can be used to disable ejection or to ramp it up slowly. Defaults
1502 # to 100.
1503 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1504 # outlier status is detected through success rate statistics. This setting
1505 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
1506 #
1507 # Not supported when the backend service uses Serverless NEG.
1508 &quot;interval&quot;: { # A Duration represents a fixed-length span of time represented # Time interval between ejection analysis sweeps. This can result in both new
1509 # ejections and backend endpoints being returned to service. The interval is
1510 # equal to the number of seconds as defined in
1511 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
1512 # in outlierDetection.interval.nanos. Defaults to 1 second.
1513 # as a count of seconds and fractions of seconds at nanosecond
1514 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1515 # or &quot;month&quot;. Range is approximately 10,000 years.
1516 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1517 # Durations less than one second are represented with a 0
1518 # `seconds` field and a positive `nanos` field. Must be from 0
1519 # to 999,999,999 inclusive.
1520 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1521 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1522 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1523 },
1524 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
1525 # backend service that can be ejected if the ejection conditions are met.
1526 # Defaults to 50%.
1527 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
1528 # enough request volume to detect success rate outliers. If the number of
1529 # backend endpoints is fewer than this setting, outlier detection via success
1530 # rate statistics is not performed for any backend endpoint in the load
1531 # balancing pool. Defaults to 5.
1532 #
1533 # Not supported when the backend service uses Serverless NEG.
1534 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
1535 # (as defined by the interval duration above) to include this backend
1536 # endpoint in success rate based outlier detection. If the volume is lower
1537 # than this setting, outlier detection via success rate statistics is not
1538 # performed for that backend endpoint. Defaults to 100.
1539 #
1540 # Not supported when the backend service uses Serverless NEG.
1541 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
1542 # outlier ejection. The ejection threshold is the difference between the mean
1543 # success rate, and the product of this factor and the standard deviation of
1544 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
1545 # is divided by a thousand to get a double. That is, if the desired factor
1546 # is 1.9, the runtime value should be 1900. Defaults to 1900.
1547 #
1548 # Not supported when the backend service uses Serverless NEG.
1549 },
1550 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1551 # as part of resource payload.
1552 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1553 # Tag keys and values have the same definition as resource
1554 # manager tags. The field is allowed for INSERT
1555 # only. The keys/values to set on the resource should be specified in
1556 # either ID { : } or Namespaced format
1557 # { : }.
1558 # For example the following are valid inputs:
1559 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1560 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1561 # Note:
1562 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1563 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1564 &quot;a_key&quot;: &quot;A String&quot;,
1565 },
1566 },
1567 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
1568 # the backend. The default value is 80.
1569 # For internal passthrough Network Load Balancers and external passthrough
1570 # Network Load Balancers, omit port.
1571 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
1572 # communication to the backend VMs in that group. The
1573 # named port must be [defined on each backend instance
1574 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
1575 # This parameter has no meaning if the backends are NEGs. For internal
1576 # passthrough Network Load Balancers and external passthrough Network Load
1577 # Balancers, omit port_name.
1578 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
1579 # with backends.
1580 #
1581 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
1582 # depending on the chosen load balancer or Traffic Director configuration.
1583 # Refer to the documentation for the load balancers or for Traffic Director
1584 # for more information.
1585 #
1586 # Must be set to GRPC when the backend service is referenced by a URL map
1587 # that is bound to target gRPC proxy.
1588 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
1589 # resides. This field is not applicable to global backend services.
1590 # You must specify this field as part of the HTTP request URL. It is
1591 # not settable as a field in the request body.
1592 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1593 # backend service.
1594 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
1595 # service. This field is applicable to a global backend service with the
1596 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
1597 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
1598 &quot;awsV4Authentication&quot;: { # Contains the configurations necessary to generate a signature for access to # The configuration needed to generate a signature for access to private
1599 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
1600 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
1601 # private storage buckets that support Signature Version 4 for authentication.
1602 # The service name for generating the authentication header will always default
1603 # to &#x27;s3&#x27;.
1604 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
1605 # creating a backend that uses AWS v4 signature authentication, but will not
1606 # be returned as part of the configuration when queried with a REST API GET
1607 # request.
1608 #
1609 # @InputOnly
1610 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
1611 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
1612 # keep track of different iterations of your access key.
1613 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
1614 # the name of the region your cloud uses to host your origin. For example,
1615 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
1616 },
1617 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
1618 # that describes how clients should authenticate with this service&#x27;s
1619 # backends.
1620 #
1621 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
1622 # to INTERNAL_SELF_MANAGED.
1623 #
1624 # If left blank, communications are not encrypted.
1625 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
1626 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
1627 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
1628 # specified values, the communication continues. Otherwise, it fails. This
1629 # additional check enables the client to verify that the server is authorized
1630 # to run the requested service.
1631 #
1632 # Note that the contents of the server
1633 # certificate&#x27;s subjectAltName field are configured by the
1634 # Public Key Infrastructure which provisions server identities.
1635 #
1636 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
1637 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
1638 # mode).
1639 &quot;A String&quot;,
1640 ],
1641 },
1642 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1643 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
1644 #
1645 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
1646 # If set, lists of backends and health checks must be both empty.
1647 &quot;A String&quot;,
1648 ],
1649 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
1650 #
1651 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
1652 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
1653 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
1654 #
1655 # Only NONE and HEADER_FIELD are supported
1656 # when the backend service is referenced by a URL map that is bound to
1657 # target gRPC proxy that has validateForProxyless field set to true.
1658 #
1659 # For more details, see:
1660 # [Session
1661 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
1662 #
1663 # sessionAffinity cannot be specified with haPolicy.
1664 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
1665 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
1666 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
1667 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
1668 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
1669 # as a count of seconds and fractions of seconds at nanosecond
1670 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1671 # or &quot;month&quot;. Range is approximately 10,000 years.
1672 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1673 # Durations less than one second are represented with a 0
1674 # `seconds` field and a positive `nanos` field. Must be from 0
1675 # to 999,999,999 inclusive.
1676 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1677 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1678 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1679 },
1680 },
1681 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
1682 # Currently this is applicable only for Internal TCP/UDP load balancing,
1683 # Internal HTTP(S) load balancing and Traffic Director.
1684 &quot;policy&quot;: &quot;A String&quot;,
1685 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
1686 # each service mesh client.
1687 #
1688 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
1689 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
1690 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
1691 # `INTERNAL_SELF_MANAGED`.
1692 #
1693 # `subset_size` is optional for Internal HTTP(S) load balancing
1694 # and required for Traffic Director.
1695 #
1696 # If you do not provide this value, Cloud Load Balancing will calculate it
1697 # dynamically to optimize the number of proxies/clients visible to each
1698 # backend and vice versa.
1699 #
1700 # Must be greater than 0. If `subset_size` is larger than the number of
1701 # backends/endpoints, then subsetting is disabled.
1702 },
1703 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
1704 # type of load balancer. For more information see,
1705 # Backend service settings.
1706 # The default is 30 seconds.
1707 # The full range of timeout values allowed goes from 1
1708 # through 2,147,483,647 seconds.
1709 #
1710 # This value can be overridden in the PathMatcher configuration of the
1711 # UrlMap that references this backend service.
1712 #
1713 # Not supported when the backend service is referenced by a URL map that is
1714 # bound to target gRPC proxy that has validateForProxyless field set to true.
1715 # Instead, use maxStreamDuration.
1716 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
1717 # when the backend protocol is SSL, HTTPS or HTTP2.
1718 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
1719 # networksecurity.googleapis.com namespace. Can be used in authenticating
1720 # TLS connections to the backend, as specified by the authenticationMode
1721 # field. Can only be specified if authenticationMode is not NONE.
1722 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
1723 #
1724 #
1725 # Use this property to configure the load balancer back-end to use
1726 # certificates and roots of trust provisioned by the Managed Workload
1727 # Identity system.
1728 #
1729 # The `identity` property is the
1730 # fully-specified SPIFFE ID to use in the SVID presented by the Load
1731 # Balancer Workload.
1732 #
1733 # The SPIFFE ID must be a resource starting with the
1734 # `trustDomain` property value, followed by the path to the Managed
1735 # Workload Identity.
1736 #
1737 # Supported SPIFFE ID format:
1738 #
1739 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
1740 #
1741 #
1742 # The Trust Domain within the Managed Identity must refer to a valid
1743 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
1744 # will be inherited from the Workload Identity Pool.
1745 #
1746 # Restrictions:
1747 #
1748 # - If you set the `identity` property, you cannot manually set
1749 # the following fields:
1750 # - tlsSettings.sni
1751 # - tlsSettings.subjectAltNames
1752 # - tlsSettings.authenticationConfig
1753 #
1754 #
1755 # When defining a `identity` for a RegionBackendServices, the
1756 # corresponding Workload Identity Pool must have a ca_pool
1757 # configured in the same region.
1758 #
1759 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
1760 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
1761 # balancer sends this string as the SNI hostname in the TLS connection to
1762 # the backend, and requires that this string match a Subject Alternative
1763 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
1764 # NEG backend, if the SNI is specified here, the load balancer uses it
1765 # regardless of whether the Regional Internet NEG is specified with FQDN or
1766 # IP address and port. When both sni and subjectAltNames[] are specified,
1767 # the load balancer matches the backend certificate&#x27;s SAN only to
1768 # subjectAltNames[].
1769 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
1770 # verifies during a TLS handshake with the backend. When the server
1771 # presents its X.509 certificate to the Load Balancer, the Load Balancer
1772 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
1773 # match one of the subjectAltNames in the list. This field is limited to 5
1774 # entries. When both sni and subjectAltNames[] are specified, the load
1775 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
1776 { # A Subject Alternative Name that the load balancer matches against the SAN
1777 # field in the TLS certificate provided by the backend, specified as either
1778 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
1779 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
1780 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
1781 },
1782 ],
1783 },
1784 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
1785 {
1786 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
1787 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
1788 # and ForwardingRule.
1789 },
1790 ],
1791 }</pre>
1792 </div>
1793
1794 <div class="method">
1795 <code class="details" id="getHealth">getHealth(project, region, backendService, body=None, x__xgafv=None)</code>
1796 <pre>Gets the most recent health check results for this
1797 regional BackendService.
1798
1799 Args:
1800 project: string, A parameter (required)
1801 region: string, Name of the region scoping this request. (required)
1802 backendService: string, Name of the BackendService resource for which to get health. (required)
1803 body: object, The request body.
1804 The object takes the form of:
1805
1806 {
1807 &quot;group&quot;: &quot;A String&quot;, # A URI referencing one of the instance groups or network endpoint groups
1808 # listed in the backend service.
1809 }
1810
1811 x__xgafv: string, V1 error format.
1812 Allowed values
1813 1 - v1 error format
1814 2 - v2 error format
1815
1816 Returns:
1817 An object of the form:
1818
1819 {
1820 &quot;annotations&quot;: { # Metadata defined as annotations on the network endpoint group.
1821 &quot;a_key&quot;: &quot;A String&quot;,
1822 },
1823 &quot;healthStatus&quot;: [ # Health state of the backend instances or endpoints in requested instance or
1824 # network endpoint group, determined based on configured health checks.
1825 {
1826 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
1827 &quot;a_key&quot;: &quot;A String&quot;,
1828 },
1829 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
1830 # instance.
1831 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
1832 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
1833 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
1834 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
1835 # rule&#x27;s IP address assigned to this instance. For other types of load
1836 # balancing, the field indicates VM internal ip.
1837 &quot;ipv6Address&quot;: &quot;A String&quot;,
1838 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
1839 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
1840 # health-checked.
1841 &quot;weight&quot;: &quot;A String&quot;,
1842 &quot;weightError&quot;: &quot;A String&quot;,
1843 },
1844 ],
1845 &quot;kind&quot;: &quot;compute#backendServiceGroupHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend
1846 # services.
1847 }</pre>
1848 </div>
1849
1850 <div class="method">
1851 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1852 <pre>Gets the access control policy for a resource. May be empty if no such
1853 policy or resource exists.
1854
1855 Args:
1856 project: string, Project ID for this request. (required)
1857 region: string, The name of the region for this request. (required)
1858 resource: string, Name or id of the resource for this request. (required)
1859 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1860 x__xgafv: string, V1 error format.
1861 Allowed values
1862 1 - v1 error format
1863 2 - v2 error format
1864
1865 Returns:
1866 An object of the form:
1867
1868 { # An Identity and Access Management (IAM) policy, which specifies access
1869 # controls for Google Cloud resources.
1870 #
1871 #
1872 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1873 # `members`, or principals, to a single `role`. Principals can be user
1874 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1875 # `role` is a named list of permissions; each `role` can be an IAM predefined
1876 # role or a user-created custom role.
1877 #
1878 # For some types of Google Cloud resources, a `binding` can also specify a
1879 # `condition`, which is a logical expression that allows access to a resource
1880 # only if the expression evaluates to `true`. A condition can add constraints
1881 # based on attributes of the request, the resource, or both. To learn which
1882 # resources support conditions in their IAM policies, see the
1883 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1884 #
1885 # **JSON example:**
1886 #
1887 # ```
1888 # {
1889 # &quot;bindings&quot;: [
1890 # {
1891 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1892 # &quot;members&quot;: [
1893 # &quot;user:[email protected]&quot;,
1894 # &quot;group:[email protected]&quot;,
1895 # &quot;domain:google.com&quot;,
1896 # &quot;serviceAccount:[email protected]&quot;
1897 # ]
1898 # },
1899 # {
1900 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1901 # &quot;members&quot;: [
1902 # &quot;user:[email protected]&quot;
1903 # ],
1904 # &quot;condition&quot;: {
1905 # &quot;title&quot;: &quot;expirable access&quot;,
1906 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1907 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1908 # }
1909 # }
1910 # ],
1911 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1912 # &quot;version&quot;: 3
1913 # }
1914 # ```
1915 #
1916 # **YAML example:**
1917 #
1918 # ```
1919 # bindings:
1920 # - members:
1921 # - user:[email protected]
1922 # - group:[email protected]
1923 # - domain:google.com
1924 # - serviceAccount:[email protected]
1925 # role: roles/resourcemanager.organizationAdmin
1926 # - members:
1927 # - user:[email protected]
1928 # role: roles/resourcemanager.organizationViewer
1929 # condition:
1930 # title: expirable access
1931 # description: Does not grant access after Sep 2020
1932 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1933 # etag: BwWWja0YfJA=
1934 # version: 3
1935 # ```
1936 #
1937 # For a description of IAM and its features, see the
1938 # [IAM documentation](https://cloud.google.com/iam/docs/).
1939 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1940 { # Specifies the audit configuration for a service.
1941 # The configuration determines which permission types are logged, and what
1942 # identities, if any, are exempted from logging.
1943 # An AuditConfig must have one or more AuditLogConfigs.
1944 #
1945 # If there are AuditConfigs for both `allServices` and a specific service,
1946 # the union of the two AuditConfigs is used for that service: the log_types
1947 # specified in each AuditConfig are enabled, and the exempted_members in each
1948 # AuditLogConfig are exempted.
1949 #
1950 # Example Policy with multiple AuditConfigs:
1951 #
1952 # {
1953 # &quot;audit_configs&quot;: [
1954 # {
1955 # &quot;service&quot;: &quot;allServices&quot;,
1956 # &quot;audit_log_configs&quot;: [
1957 # {
1958 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1959 # &quot;exempted_members&quot;: [
1960 # &quot;user:[email protected]&quot;
1961 # ]
1962 # },
1963 # {
1964 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1965 # },
1966 # {
1967 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1968 # }
1969 # ]
1970 # },
1971 # {
1972 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1973 # &quot;audit_log_configs&quot;: [
1974 # {
1975 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1976 # },
1977 # {
1978 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1979 # &quot;exempted_members&quot;: [
1980 # &quot;user:[email protected]&quot;
1981 # ]
1982 # }
1983 # ]
1984 # }
1985 # ]
1986 # }
1987 #
1988 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1989 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1990 # `[email protected]` from DATA_WRITE logging.
1991 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1992 { # Provides the configuration for logging a type of permissions.
1993 # Example:
1994 #
1995 # {
1996 # &quot;audit_log_configs&quot;: [
1997 # {
1998 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1999 # &quot;exempted_members&quot;: [
2000 # &quot;user:[email protected]&quot;
2001 # ]
2002 # },
2003 # {
2004 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2005 # }
2006 # ]
2007 # }
2008 #
2009 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2010 # [email protected] from DATA_READ logging.
2011 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2012 # permission.
2013 # Follows the same format of Binding.members.
2014 &quot;A String&quot;,
2015 ],
2016 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2017 },
2018 ],
2019 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2020 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2021 # `allServices` is a special value that covers all services.
2022 },
2023 ],
2024 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2025 # may specify a `condition` that determines how and when the `bindings` are
2026 # applied. Each of the `bindings` must contain at least one principal.
2027 #
2028 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2029 # of these principals can be Google groups. Each occurrence of a principal
2030 # counts towards these limits. For example, if the `bindings` grant 50
2031 # different roles to `user:[email protected]`, and not to any other
2032 # principal, then you can add another 1,450 principals to the `bindings` in
2033 # the `Policy`.
2034 { # Associates `members`, or principals, with a `role`.
2035 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2036 #
2037 # If the condition evaluates to `true`, then this binding applies to the
2038 # current request.
2039 #
2040 # If the condition evaluates to `false`, then this binding does not apply to
2041 # the current request. However, a different role binding might grant the same
2042 # role to one or more of the principals in this binding.
2043 #
2044 # To learn which resources support conditions in their IAM policies, see the
2045 # [IAM
2046 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2047 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2048 # are documented at https://github.com/google/cel-spec.
2049 #
2050 # Example (Comparison):
2051 #
2052 # title: &quot;Summary size limit&quot;
2053 # description: &quot;Determines if a summary is less than 100 chars&quot;
2054 # expression: &quot;document.summary.size() &lt; 100&quot;
2055 #
2056 # Example (Equality):
2057 #
2058 # title: &quot;Requestor is owner&quot;
2059 # description: &quot;Determines if requestor is the document owner&quot;
2060 # expression: &quot;document.owner == request.auth.claims.email&quot;
2061 #
2062 # Example (Logic):
2063 #
2064 # title: &quot;Public documents&quot;
2065 # description: &quot;Determine whether the document should be publicly visible&quot;
2066 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2067 #
2068 # Example (Data Manipulation):
2069 #
2070 # title: &quot;Notification string&quot;
2071 # description: &quot;Create a notification string with a timestamp.&quot;
2072 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2073 #
2074 # The exact variables and functions that may be referenced within an expression
2075 # are determined by the service that evaluates it. See the service
2076 # documentation for additional information.
2077 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2078 # describes the expression, e.g. when hovered over it in a UI.
2079 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2080 # syntax.
2081 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2082 # reporting, e.g. a file name and a position in the file.
2083 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2084 # its purpose. This can be used e.g. in UIs which allow to enter the
2085 # expression.
2086 },
2087 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2088 # `members` can have the following values:
2089 #
2090 # * `allUsers`: A special identifier that represents anyone who is
2091 # on the internet; with or without a Google account.
2092 #
2093 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2094 # who is authenticated with a Google account or a service account.
2095 # Does not include identities that come from external identity providers
2096 # (IdPs) through identity federation.
2097 #
2098 # * `user:{emailid}`: An email address that represents a specific Google
2099 # account. For example, `[email protected]` .
2100 #
2101 #
2102 # * `serviceAccount:{emailid}`: An email address that represents a Google
2103 # service account. For example,
2104 # `[email protected]`.
2105 #
2106 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2107 # identifier for a
2108 # [Kubernetes service
2109 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2110 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2111 #
2112 # * `group:{emailid}`: An email address that represents a Google group.
2113 # For example, `[email protected]`.
2114 #
2115 #
2116 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2117 # users of that domain. For example, `google.com` or `example.com`.
2118 #
2119 #
2120 #
2121 #
2122 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2123 # A single identity in a workforce identity pool.
2124 #
2125 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2126 # All workforce identities in a group.
2127 #
2128 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2129 # All workforce identities with a specific attribute value.
2130 #
2131 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2132 # All identities in a workforce identity pool.
2133 #
2134 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2135 # A single identity in a workload identity pool.
2136 #
2137 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2138 # A workload identity pool group.
2139 #
2140 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2141 # All identities in a workload identity pool with a certain attribute.
2142 #
2143 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2144 # All identities in a workload identity pool.
2145 #
2146 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2147 # identifier) representing a user that has been recently deleted. For
2148 # example, `[email protected]?uid=123456789012345678901`. If the user is
2149 # recovered, this value reverts to `user:{emailid}` and the recovered user
2150 # retains the role in the binding.
2151 #
2152 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2153 # unique identifier) representing a service account that has been recently
2154 # deleted. For example,
2155 # `[email protected]?uid=123456789012345678901`.
2156 # If the service account is undeleted, this value reverts to
2157 # `serviceAccount:{emailid}` and the undeleted service account retains the
2158 # role in the binding.
2159 #
2160 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2161 # identifier) representing a Google group that has been recently
2162 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2163 # the group is recovered, this value reverts to `group:{emailid}` and the
2164 # recovered group retains the role in the binding.
2165 #
2166 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2167 # Deleted single identity in a workforce identity pool. For example,
2168 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2169 &quot;A String&quot;,
2170 ],
2171 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2172 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2173 #
2174 # For an overview of the IAM roles and permissions, see the
2175 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2176 # a list of the available pre-defined roles, see
2177 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2178 },
2179 ],
2180 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2181 # prevent simultaneous updates of a policy from overwriting each other.
2182 # It is strongly suggested that systems make use of the `etag` in the
2183 # read-modify-write cycle to perform policy updates in order to avoid race
2184 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2185 # systems are expected to put that etag in the request to `setIamPolicy` to
2186 # ensure that their change will be applied to the same version of the policy.
2187 #
2188 # **Important:** If you use IAM Conditions, you must include the `etag` field
2189 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2190 # you to overwrite a version `3` policy with a version `1` policy, and all of
2191 # the conditions in the version `3` policy are lost.
2192 &quot;version&quot;: 42, # Specifies the format of the policy.
2193 #
2194 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2195 # are rejected.
2196 #
2197 # Any operation that affects conditional role bindings must specify version
2198 # `3`. This requirement applies to the following operations:
2199 #
2200 # * Getting a policy that includes a conditional role binding
2201 # * Adding a conditional role binding to a policy
2202 # * Changing a conditional role binding in a policy
2203 # * Removing any role binding, with or without a condition, from a policy
2204 # that includes conditions
2205 #
2206 # **Important:** If you use IAM Conditions, you must include the `etag` field
2207 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2208 # you to overwrite a version `3` policy with a version `1` policy, and all of
2209 # the conditions in the version `3` policy are lost.
2210 #
2211 # If a policy does not include any conditions, operations on that policy may
2212 # specify any valid version or leave the field unset.
2213 #
2214 # To learn which resources support conditions in their IAM policies, see the
2215 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2216 }</pre>
2217 </div>
2218
2219 <div class="method">
2220 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
2221 <pre>Creates a regional BackendService resource in the specified project using
2222 the data included in the request. For more information, see
2223 Backend services overview.
2224
2225 Args:
2226 project: string, Project ID for this request. (required)
2227 region: string, Name of the region scoping this request. (required)
2228 body: object, The request body.
2229 The object takes the form of:
2230
2231 { # Represents a Backend Service resource.
2232 #
2233 # A backend service defines how Google Cloud load balancers distribute traffic.
2234 # The backend service configuration contains a set of values, such as the
2235 # protocol used to connect to backends, various distribution and session
2236 # settings, health checks, and timeouts. These settings provide fine-grained
2237 # control over how your load balancer behaves. Most of the settings have
2238 # default values that allow for easy configuration if you need to get started
2239 # quickly.
2240 #
2241 # Backend services in Google Compute Engine can be either regionally or
2242 # globally scoped.
2243 #
2244 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
2245 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
2246 #
2247 # For more information, seeBackend
2248 # Services.
2249 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
2250 # Load Balancers and Traffic Director and requires
2251 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
2252 #
2253 # If set to 0, the cookie is non-persistent and lasts only until
2254 # the end of the browser session (or equivalent). The maximum allowed value
2255 # is two weeks (1,209,600).
2256 #
2257 # Not supported when the backend service is referenced by a URL map that is
2258 # bound to target gRPC proxy that has validateForProxyless field set to true.
2259 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
2260 { # Message containing information of one individual backend.
2261 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
2262 # handle additional traffic or is fully loaded. For usage guidelines, see
2263 # Connection balancing mode.
2264 #
2265 # Backends must use compatible balancing modes. For more information, see
2266 # Supported balancing modes and target capacity settings and
2267 # Restrictions and guidance for instance groups.
2268 #
2269 # Note: Currently, if you use the API to configure incompatible balancing
2270 # modes, the configuration might be accepted even though it has no impact
2271 # and is ignored. Specifically, Backend.maxUtilization is ignored when
2272 # Backend.balancingMode is RATE. In the future, this incompatible combination
2273 # will be rejected.
2274 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
2275 # mode.
2276 # The default value is 1, which means the group serves up to
2277 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
2278 # completely drained, offering 0% of its available capacity. The valid ranges
2279 # are 0.0 and [0.1,1.0].
2280 # You cannot configure a setting larger than 0 and smaller than0.1.
2281 # You cannot configure a setting of 0 when there is only one
2282 # backend attached to the backend service.
2283 #
2284 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
2285 # internet NEGs, regional serverless NEGs, and PSC NEGs.
2286 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
2287 # BalancingMode.
2288 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
2289 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
2290 # Monitoring, but is not used for load balancing.
2291 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
2292 # balancing mode. The valid range is [0.0, 1.0].
2293 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2294 # long and match the regular expression
2295 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2296 # first character must be a lowercase letter, and all following
2297 # characters must be a dash, period, underscore, lowercase letter, or
2298 # digit, except the last character, which cannot be a dash, period, or
2299 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2300 # field can only be used for a global or regional backend service with the
2301 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2302 },
2303 ],
2304 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2305 # create the resource.
2306 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
2307 # failover backend can be configured for a given BackendService.
2308 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
2309 # group or network endpoint
2310 # group (NEG) resource. To determine what types of backends a load
2311 # balancer supports, see the [Backend services
2312 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
2313 #
2314 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
2315 # or NEG. Partial URLs are not supported.
2316 #
2317 # If haPolicy is specified, backends must refer to NEG resources of type
2318 # GCE_VM_IP.
2319 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2320 # guidelines, seeConnection
2321 # balancing mode and Utilization
2322 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
2323 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2324 # guidelines, seeConnection
2325 # balancing mode and Utilization
2326 # balancing mode.
2327 #
2328 # Not available if the backend&#x27;s balancingMode isRATE.
2329 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
2330 # For usage guidelines, seeConnection
2331 # balancing mode and Utilization
2332 # balancing mode.
2333 #
2334 # Not available if the backend&#x27;s balancingMode isRATE.
2335 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
2336 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
2337 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
2338 # Not available if backend&#x27;s balancingMode is RATE
2339 # or CONNECTION.
2340 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
2341 # Not available if backend&#x27;s balancingMode is RATE
2342 # or CONNECTION.
2343 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
2344 # usage guidelines, seeRate
2345 # balancing mode and Utilization
2346 # balancing mode.
2347 #
2348 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2349 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2350 # guidelines, seeRate
2351 # balancing mode and Utilization
2352 # balancing mode.
2353 #
2354 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2355 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2356 # guidelines, seeRate
2357 # balancing mode and Utilization
2358 # balancing mode.
2359 #
2360 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2361 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
2362 #
2363 # For usage guidelines, seeUtilization
2364 # balancing mode.
2365 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
2366 # the backend.
2367 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
2368 },
2369 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
2370 # sending traffic to backends with default preference. The possible values
2371 # are:
2372 #
2373 # - PREFERRED: Backends with this preference level will be
2374 # filled up to their capacity limits first, based on RTT.
2375 # - DEFAULT: If preferred backends don&#x27;t have enough
2376 # capacity, backends in this layer would be used and traffic would be
2377 # assigned based on the load balancing algorithm you use. This is the
2378 # default
2379 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
2380 # Attachment).
2381 # e.g.
2382 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
2383 # for Cloud Run service.
2384 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
2385 # for PSC Service Attachment.
2386 &quot;trafficDuration&quot;: &quot;A String&quot;,
2387 },
2388 ],
2389 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
2390 # specified load balancer types.
2391 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2392 # Pragma or Authorization headers. Up to 5 headers can be specified.
2393 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2394 { # Bypass the cache when the specified request headers are present,
2395 # e.g. Pragma or Authorization headers. Values are case insensitive.
2396 # The presence of such a header overrides the cache_mode setting.
2397 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2398 # Values are case-insensitive.
2399 },
2400 ],
2401 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
2402 # CDN.
2403 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
2404 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2405 &quot;A String&quot;,
2406 ],
2407 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
2408 # The name=value pair will be used in the cache key Cloud CDN generates.
2409 &quot;A String&quot;,
2410 ],
2411 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
2412 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
2413 # query_string_whitelist and query_string_blacklist. If neither is set, the
2414 # entire query string will be included. If false, the query string will be
2415 # excluded from the cache key entirely.
2416 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
2417 # parameters will be included. Either specify query_string_whitelist or
2418 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2419 # not treated as delimiters.
2420 &quot;A String&quot;,
2421 ],
2422 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
2423 # parameters will be excluded. Either specify query_string_whitelist or
2424 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2425 # not treated as delimiters.
2426 &quot;A String&quot;,
2427 ],
2428 },
2429 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2430 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2431 # headers to cache content. Responses without these headers will not be
2432 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2433 # every request, potentially impacting performance and increasing load on
2434 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2435 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2436 # Warning: this may result in Cloud CDN caching private,
2437 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2438 # including common image formats, media (video and audio), and web assets
2439 # (JavaScript and CSS). Requests and responses that are marked as
2440 # uncacheable, as well as dynamic content (including HTML), will not be
2441 # cached.
2442 #
2443 # If no value is provided for cdnPolicy.cacheMode, it defaults
2444 # to CACHE_ALL_STATIC.
2445 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2446 # used to clamp the max-age (or Expires) value sent to the client. With
2447 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2448 # response max-age directive, along with a &quot;public&quot; directive. For
2449 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2450 # from the origin (if specified), or else sets the response max-age
2451 # directive to the lesser of the client_ttl and default_ttl, and also
2452 # ensures a &quot;public&quot; cache-control directive is present.
2453 # If a client TTL is not specified, a default value (1 hour) will be used.
2454 # The maximum allowed value is 31,622,400s (1 year).
2455 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2456 # responses that do not have an existing valid TTL (max-age or s-maxage).
2457 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2458 # The value of defaultTTL cannot be set to a value greater than that of
2459 # maxTTL, but can be equal.
2460 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2461 # will overwrite the TTL set in all responses. The maximum allowed value is
2462 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2463 # evicted from the cache before the defined TTL.
2464 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2465 # origin.
2466 # Cache directives that attempt to set a max-age or s-maxage higher than
2467 # this, or an Expires header more than maxTTL seconds in the future will
2468 # be capped at the value of maxTTL, as if it were the value of an
2469 # s-maxage Cache-Control directive.
2470 # Headers sent to the client will not be modified.
2471 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2472 # The maximum allowed value is 31,622,400s (1 year), noting that
2473 # infrequently accessed objects may be evicted from the cache before
2474 # the defined TTL.
2475 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2476 # to apply fine-grained caching for common errors or redirects.
2477 # This can reduce the load on your origin and improve end-user
2478 # experience by reducing response latency.
2479 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2480 # negative caching applies to responses with the specified response code
2481 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2482 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2483 # to all responses with the specified response code, and override any
2484 # caching headers.
2485 # By default, Cloud CDN will apply the following default TTLs to these
2486 # status codes:
2487 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2488 # HTTP 404 (Not Found), 410 (Gone),
2489 # 451 (Unavailable For Legal Reasons): 120s
2490 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2491 # These defaults can be overridden in negative_caching_policy.
2492 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2493 # negative_caching must be enabled to configure negative_caching_policy.
2494 # Omitting the policy and leaving negative_caching enabled will use
2495 # Cloud CDN&#x27;s default cache TTLs.
2496 # Note that when specifying an explicit negative_caching_policy, you
2497 # should take care to specify a cache TTL for all response codes
2498 # that you wish to cache. Cloud CDN will not apply any default
2499 # negative caching when a policy exists.
2500 { # Specify CDN TTLs for response error codes.
2501 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2502 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2503 # specified as values, and you cannot specify a status code more than
2504 # once.
2505 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2506 # corresponding status code.
2507 # The maximum allowed value is 1800s (30 minutes), noting that
2508 # infrequently accessed objects may be evicted from the cache before the
2509 # defined TTL.
2510 },
2511 ],
2512 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2513 # requests into a small number of requests to the origin.
2514 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2515 # content with the origin, or when an error is encountered when refreshing
2516 # the cache.
2517 # This setting defines the default &quot;max-stale&quot; duration for any cached
2518 # responses that do not specify a max-stale directive. Stale responses that
2519 # exceed the TTL configured here will not be served. The default limit
2520 # (max-stale) is 86400s (1 day), which will allow stale content to be
2521 # served up to this limit beyond the max-age (or s-maxage) of a cached
2522 # response.
2523 # The maximum allowed value is 604800 (1 week).
2524 # Set this to zero (0) to disable serve-while-stale.
2525 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2526 # considered fresh. After this time period, the response will be
2527 # revalidated before being served. Defaults to 1hr (3600s). When serving
2528 # responses to signed URL requests, Cloud CDN will internally behave as
2529 # though all responses from this backend had a &quot;Cache-Control:
2530 # public, max-age=[TTL]&quot; header, regardless of any existing
2531 # Cache-Control header. The actual headers served in responses will not be
2532 # altered.
2533 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2534 &quot;A String&quot;,
2535 ],
2536 },
2537 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
2538 # backend service.
2539 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
2540 # as a count of seconds and fractions of seconds at nanosecond
2541 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2542 # or &quot;month&quot;. Range is approximately 10,000 years.
2543 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2544 # Durations less than one second are represented with a 0
2545 # `seconds` field and a positive `nanos` field. Must be from 0
2546 # to 999,999,999 inclusive.
2547 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2548 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2549 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2550 },
2551 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
2552 # there is no limit.
2553 #
2554 # Not supported when the backend service is referenced by a URL map that is
2555 # bound to target gRPC proxy that has validateForProxyless field set to true.
2556 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
2557 # not specified, there is no limit.
2558 #
2559 # Not supported when the backend service is referenced by a URL map that is
2560 # bound to target gRPC proxy that has validateForProxyless field set to true.
2561 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
2562 # service. If not specified, there is no limit.
2563 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
2564 # This parameter is respected by both the HTTP/1.1 and HTTP/2
2565 # implementations. If not specified, there is no limit. Setting this
2566 # parameter to 1 will effectively disable keep alive.
2567 #
2568 # Not supported when the backend service is referenced by a URL map that is
2569 # bound to target gRPC proxy that has validateForProxyless field set to true.
2570 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
2571 # not specified, the default is 1.
2572 #
2573 # Not supported when the backend service is referenced by a URL map that is
2574 # bound to target gRPC proxy that has validateForProxyless field set to true.
2575 },
2576 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2577 # the client&#x27;s Accept-Encoding header.
2578 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
2579 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
2580 # instance. For supported load balancers and protocols, as described inEnabling
2581 # connection draining.
2582 },
2583 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
2584 # tracking policy settings are only available for external passthrough
2585 # Network Load Balancers and internal passthrough Network Load Balancers.
2586 #
2587 # connectionTrackingPolicy cannot be specified with haPolicy.
2588 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
2589 # value is DEFAULT_FOR_PROTOCOL.
2590 #
2591 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
2592 # persist on unhealthy backends only for connection-oriented protocols
2593 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
2594 # Affinity is configured for 5-tuple. They do not persist forUDP.
2595 #
2596 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
2597 # the existing connections on the unhealthy backend are never persisted on
2598 # the unhealthy backend. They are always diverted to newly selected healthy
2599 # backends (unless all backends are unhealthy).
2600 #
2601 # If set to ALWAYS_PERSIST, existing connections always
2602 # persist on unhealthy backends regardless of protocol and session
2603 # affinity. It is generally not recommended to use this mode overriding the
2604 # default.
2605 #
2606 # For more details, see [Connection Persistence for Network Load
2607 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
2608 # and [Connection Persistence for Internal TCP/UDP Load
2609 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
2610 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
2611 # Balancers. This option is not available publicly.
2612 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
2613 # matching traffic (in seconds).
2614 #
2615 # For internal passthrough Network Load Balancers:
2616 #
2617 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
2618 # - It can be set only if Connection Tracking is less than 5-tuple
2619 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
2620 # Mode is PER_SESSION).
2621 #
2622 #
2623 #
2624 # For external passthrough Network Load Balancers the default is 60
2625 # seconds. This option is not available publicly.
2626 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
2627 # options:
2628 #
2629 # - PER_CONNECTION: This is the default mode. The Connection
2630 # Tracking is performed as per the Connection Key (default Hash Method) for
2631 # the specific protocol.
2632 # - PER_SESSION: The Connection Tracking is performed as per
2633 # the configured Session Affinity. It matches the configured Session
2634 # Affinity.
2635 #
2636 #
2637 #
2638 # For more details, see [Tracking Mode for Network Load
2639 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
2640 # and [Tracking Mode for Internal TCP/UDP Load
2641 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
2642 },
2643 &quot;consistentHash&quot;: { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session
2644 # affinity based on HTTP headers, cookies or other properties. This load
2645 # balancing policy is applicable only for HTTP connections. The affinity to a
2646 # particular destination host will be lost when one or more hosts are
2647 # added/removed from the destination service. This field specifies parameters
2648 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
2649 #
2650 # This field is applicable to either:
2651 #
2652 # - A regional backend service with the service protocol set to HTTP,
2653 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
2654 # INTERNAL_MANAGED.
2655 # - A global backend service with the
2656 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
2657 &quot;httpCookie&quot;: { # The information about the HTTP Cookie on which the hash function is based # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
2658 # be used as the hash key for the consistent hash load balancer. If the
2659 # cookie is not present, it will be generated. This field is applicable if
2660 # the sessionAffinity is set to HTTP_COOKIE.
2661 #
2662 # Not supported when the backend service is referenced by a URL map that is
2663 # bound to target gRPC proxy that has validateForProxyless field set to true.
2664 # for load balancing policies that use a consistent hash.
2665 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
2666 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
2667 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
2668 # as a count of seconds and fractions of seconds at nanosecond
2669 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2670 # or &quot;month&quot;. Range is approximately 10,000 years.
2671 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2672 # Durations less than one second are represented with a 0
2673 # `seconds` field and a positive `nanos` field. Must be from 0
2674 # to 999,999,999 inclusive.
2675 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2676 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2677 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2678 },
2679 },
2680 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
2681 # applicable if the sessionAffinity is set toHEADER_FIELD.
2682 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
2683 # 1024. Larger ring sizes result in more granular load distributions. If the
2684 # number of hosts in the load balancing pool is larger than the ring size,
2685 # each host will be assigned a single virtual node.
2686 },
2687 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2688 # text format.
2689 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
2690 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
2691 # locality_lb_policy.
2692 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
2693 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2694 # long and match the regular expression
2695 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2696 # first character must be a lowercase letter, and all following
2697 # characters must be a dash, period, underscore, lowercase letter, or
2698 # digit, except the last character, which cannot be a dash, period, or
2699 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2700 # field can only be used for a global or regional backend service with the
2701 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2702 },
2703 ],
2704 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
2705 # custom
2706 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
2707 &quot;A String&quot;,
2708 ],
2709 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
2710 # custom
2711 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
2712 &quot;A String&quot;,
2713 ],
2714 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2715 # create the resource.
2716 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
2717 # backend service with dynamic forwarding feature which together with Service
2718 # Extension allows customized and complex routing logic.
2719 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
2720 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
2721 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
2722 },
2723 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
2724 # service. Some ranges are restricted: Restricted
2725 # ranges.
2726 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
2727 },
2728 },
2729 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2730 # this backend service.
2731 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
2732 # global external Application Load Balancer.
2733 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
2734 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
2735 #
2736 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
2737 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
2738 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
2739 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
2740 # externalManagedMigrationTestingPercentage.
2741 #
2742 # Rolling back a migration requires the states to be set in reverse order. So
2743 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
2744 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
2745 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
2746 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
2747 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
2748 # external Application Load Balancer.
2749 #
2750 # The value of this field must be in the range [0, 100].
2751 #
2752 # Session affinity options will slightly affect this routing behavior, for
2753 # more details, see:Session
2754 # Affinity.
2755 #
2756 # This value can only be set if the loadBalancingScheme in the BackendService
2757 # is set to EXTERNAL (when using the classic Application Load Balancer) and
2758 # the migration state is TEST_BY_PERCENTAGE.
2759 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
2760 # as a backup (failover) backend.
2761 # For load balancers that have configurable failover:
2762 # [Internal passthrough Network Load
2763 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2764 # and [external passthrough Network Load
2765 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2766 #
2767 # failoverPolicy cannot be specified with haPolicy.
2768 # failover:
2769 # [Internal passthrough Network Load
2770 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2771 # and [external passthrough
2772 # Network Load
2773 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2774 # On failover or failback, this field indicates whether connection draining
2775 # will be honored. Google Cloud has a fixed connection draining timeout of
2776 # 10 minutes. A setting of true terminates existing TCP
2777 # connections to the active pool during failover and failback, immediately
2778 # draining traffic. A setting of false allows existing TCP
2779 # connections to persist, even on VMs no longer in the active pool, for up
2780 # to the duration of the connection draining timeout (10 minutes).
2781 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
2782 #
2783 # The default is false.
2784 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
2785 # load balancer are dropped when all primary and all backup backend VMs are
2786 # unhealthy.If set to false, connections are distributed
2787 # among all primary VMs when all primary and all backup backend VMs are
2788 # unhealthy.
2789 # For load balancers that have configurable
2790 # failover:
2791 # [Internal passthrough
2792 # Network Load
2793 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2794 # and [external passthrough
2795 # Network Load
2796 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2797 # The default is false.
2798 &quot;failoverRatio&quot;: 3.14, # The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
2799 # failover when the number of healthy primary VMs equals zero.
2800 # For all other values, the load balancer performs a failover when the
2801 # total number of healthy primary VMs is less than this ratio.
2802 # For load balancers that have configurable
2803 # failover:
2804 # [Internal TCP/UDP Load
2805 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2806 # and [external TCP/UDP Load
2807 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2808 },
2809 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
2810 # This field is used in optimistic locking. This field will be ignored when
2811 # inserting a BackendService. An up-to-date fingerprint must be provided in
2812 # order to update the BackendService, otherwise the request will
2813 # fail with error 412 conditionNotMet.
2814 #
2815 # To see the latest fingerprint, make a get() request to
2816 # retrieve a BackendService.
2817 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
2818 # Protocol Forwarding.
2819 #
2820 # The backends of this regional backend service must only specify zonal
2821 # network endpoint groups (NEGs) of type GCE_VM_IP.
2822 #
2823 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
2824 # regional backend service must set the network field. All zonal NEGs must
2825 # belong to the same network. However, individual NEGs can
2826 # belong to different subnetworks of that network.
2827 #
2828 # When haPolicy is specified, the set of attached network endpoints across
2829 # all backends comprise an High Availability domain from which one endpoint
2830 # is selected as the active endpoint (the leader) that receives all
2831 # traffic.
2832 #
2833 # haPolicy can be added only at backend service creation time. Once set up,
2834 # it cannot be deleted.
2835 #
2836 # Note that haPolicy is not for load balancing, and therefore cannot be
2837 # specified with sessionAffinity, connectionTrackingPolicy, and
2838 # failoverPolicy.
2839 #
2840 # haPolicy requires customers to be responsible for tracking backend
2841 # endpoint health and electing a leader among the healthy endpoints.
2842 # Therefore, haPolicy cannot be specified with healthChecks.
2843 #
2844 # haPolicy can only be specified for External Passthrough Network Load
2845 # Balancers and Internal Passthrough Network Load Balancers.
2846 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
2847 # achieve it.
2848 #
2849 # Supported values are:
2850 #
2851 # - DISABLED: Fast IP Move is disabled. You can only use the
2852 # haPolicy.leader API to update the leader.
2853 # - &gt;GARP_RA: Provides a method to very quickly define a new network
2854 # endpoint as the leader. This method is faster than updating the leader
2855 # using the haPolicy.leader API. Fast IP move works as follows: The VM
2856 # hosting the network endpoint that should become the new leader sends
2857 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
2858 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
2859 # temporarily associates the forwarding rule IP address with that VM, and
2860 # both new and in-flight packets are quickly delivered to that VM.
2861 #
2862 #
2863 #
2864 # Note the important properties of the Fast IP Move functionality:
2865 #
2866 # - The GARP/RA-initiated re-routing stays active for approximately 20
2867 # minutes. After triggering fast failover, you must also
2868 # appropriately set the haPolicy.leader.
2869 # - The new leader instance should continue to send GARP/RA packets
2870 # periodically every 10 seconds until at least 10 minutes after updating
2871 # the haPolicy.leader (but stop immediately if it is no longer the leader).
2872 # - After triggering a fast failover, we recommend that you wait at least
2873 # 3 seconds before sending another GARP/RA packet from a different VM
2874 # instance to avoid race conditions.
2875 # - Don&#x27;t send GARP/RA packets from different VM
2876 # instances at the same time. If multiple instances continue to send
2877 # GARP/RA packets, traffic might be routed to different destinations in an
2878 # alternating order. This condition ceases when a single instance
2879 # issues a GARP/RA packet.
2880 # - The GARP/RA request always takes priority over the leader API.
2881 # Using the haPolicy.leader API to change the leader to a different
2882 # instance will have no effect until the GARP/RA request becomes
2883 # inactive.
2884 # - The GARP/RA packets should follow the GARP/RA
2885 # Packet Specifications..
2886 # - When multiple forwarding rules refer to a regional backend service,
2887 # you need only send a GARP or RA packet for a single forwarding rule
2888 # virtual IP. The virtual IPs for all forwarding rules targeting the same
2889 # backend service will also be moved to the sender of the GARP or RA
2890 # packet.
2891 #
2892 #
2893 #
2894 # The following are the Fast IP Move limitations (that is, when fastIPMove
2895 # is not DISABLED):
2896 #
2897 # - Multiple forwarding rules cannot use the same IP address if one of
2898 # them refers to a regional backend service with fastIPMove.
2899 # - The regional backend service must set the network field, and all
2900 # NEGs must belong to that network. However, individual
2901 # NEGs can belong to different subnetworks of that network.
2902 # - The maximum number of network endpoints across all backends of a
2903 # backend service with fastIPMove is 32.
2904 # - The maximum number of backend services with fastIPMove that can have
2905 # the same network endpoint attached to one of its backends is 64.
2906 # - The maximum number of backend services with fastIPMove in a VPC in a
2907 # region is 64.
2908 # - The network endpoints that are attached to a backend of a backend
2909 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
2910 # - Traffic directed to the leader by a static route next hop will not be
2911 # redirected to a new leader by fast failover. Such traffic will only be
2912 # redirected once an haPolicy.leader update has taken effect. Only traffic
2913 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
2914 # fast failover.
2915 #
2916 #
2917 # haPolicy.fastIPMove can be set only at backend service creation time.
2918 # Once set, it cannot be updated.
2919 #
2920 # By default, fastIpMove is set to DISABLED.
2921 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
2922 # this service as the active endpoint (the leader) that receives all
2923 # traffic.
2924 #
2925 # When the leader changes, there is no connection draining to persist
2926 # existing connections on the old leader.
2927 #
2928 # You are responsible for selecting a suitable endpoint as the
2929 # leader. For example, preferring a healthy endpoint over unhealthy ones.
2930 # Note that this service does not track backend endpoint health, and
2931 # selects the configured leader unconditionally.
2932 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
2933 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
2934 # that the leader is attached to.
2935 #
2936 # The leader&#x27;s backendGroup must already be specified as a backend of
2937 # this backend service. Removing a backend that is designated as the
2938 # leader&#x27;s backendGroup is not permitted.
2939 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
2940 # designated as the leader.
2941 #
2942 # This network endpoint cannot be detached from the NEG specified in
2943 # the haPolicy.leader.backendGroup until the leader is updated with
2944 # another network endpoint, or the leader is removed from the haPolicy.
2945 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
2946 # instance must already be attached to the NEG specified in the
2947 # haPolicy.leader.backendGroup.
2948 #
2949 # The name must be 1-63 characters long, and comply with RFC1035.
2950 # Authorization requires the following IAM permission on the
2951 # specified resource instance: compute.instances.use
2952 },
2953 },
2954 },
2955 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
2956 # httpsHealthChecks (legacy) resource for health checking this backend
2957 # service. Not all backend services support legacy health checks. See
2958 # Load balancer guide. Currently, at most one health check can be
2959 # specified for each backend service. Backend services with
2960 # instance group or zonal NEG backends must have a health check unless
2961 # haPolicy is specified. Backend services with internet or serverless NEG
2962 # backends must not have a health check.
2963 #
2964 # healthChecks[] cannot be specified with haPolicy.
2965 &quot;A String&quot;,
2966 ],
2967 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
2968 # Not available for internal passthrough Network Load Balancers and external
2969 # passthrough Network Load Balancers.
2970 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
2971 # incoming requests.
2972 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
2973 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
2974 # For security reasons, this value cannot be retrieved via the API.
2975 # Instead, the SHA-256 hash of the value is returned in the
2976 # oauth2ClientSecretSha256 field.
2977 #
2978 # @InputOnly
2979 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
2980 },
2981 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2982 # defined by the server.
2983 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
2984 # from the client to the backend for proxyless gRPC).
2985 # The possible values are:
2986 #
2987 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
2988 # backend service (Instance Group, Managed Instance Group, Network Endpoint
2989 # Group), regardless of traffic from the client to the proxy. Only IPv4
2990 # health checks are used to check the health of the backends. This is the
2991 # default setting.
2992 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
2993 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
2994 # address).
2995 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
2996 # backend service (Instance Group, Managed Instance Group, Network Endpoint
2997 # Group), regardless of traffic from the client to the proxy. Only IPv6
2998 # health checks are used to check the health of the backends.
2999 #
3000 #
3001 #
3002 # This field is applicable to either:
3003 #
3004 # - Advanced global external Application Load Balancer (load balancing
3005 # scheme EXTERNAL_MANAGED),
3006 # - Regional external Application Load
3007 # Balancer,
3008 # - Internal proxy Network Load Balancer (load balancing
3009 # scheme INTERNAL_MANAGED),
3010 # - Regional internal Application Load
3011 # Balancer (load balancing scheme INTERNAL_MANAGED),
3012 # - Traffic
3013 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
3014 # INTERNAL_SELF_MANAGED).
3015 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
3016 # for backend services.
3017 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
3018 # created for one type of load balancer cannot be used with another.
3019 # For more information, refer toChoosing
3020 # a load balancer.
3021 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
3022 # preference. When you use localityLbPolicies, you must set at least one
3023 # value for either the localityLbPolicies[].policy or the
3024 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
3025 # value set in the localityLbPolicy field.
3026 #
3027 # For an example of how to use this field, seeDefine
3028 # a list of preferred policies.
3029 #
3030 # Caution: This field and its children are intended for use in a service mesh
3031 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
3032 # that have this configuration.
3033 { # Container for either a built-in LB policy supported by gRPC or Envoy or
3034 # a custom one implemented by the end user.
3035 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
3036 # deployed with the client.
3037 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
3038 # by a locally installed custom policy implementation.
3039 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
3040 #
3041 # The value should match the name of a custom implementation registered
3042 # on the gRPC clients. It should follow protocol buffer message naming
3043 # conventions and include the full path (for example,
3044 # myorg.CustomLbPolicy). The maximum length is 256 characters.
3045 #
3046 # Do not specify the same custom policy more than once for a
3047 # backend. If you do, the configuration is rejected.
3048 #
3049 # For an example of how to use this field, seeUse
3050 # a custom policy.
3051 },
3052 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
3053 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
3054 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
3055 # about these values, see the description of localityLbPolicy.
3056 #
3057 # Do not specify the same policy more than once for a
3058 # backend. If you do, the configuration is rejected.
3059 },
3060 },
3061 ],
3062 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
3063 # possible values are:
3064 #
3065 # - ROUND_ROBIN: This is a simple policy in which each healthy
3066 # backend is selected in round robin order. This is the default.
3067 # - LEAST_REQUEST: An O(1) algorithm which
3068 # selects two random healthy hosts and picks the host which has fewer active
3069 # requests.
3070 # - RING_HASH: The ring/modulo hash load balancer implements
3071 # consistent hashing to backends. The algorithm has the property that the
3072 # addition/removal of a host from a set of N hosts only affects 1/N of the
3073 # requests.
3074 # - RANDOM: The load balancer selects a random healthy
3075 # host.
3076 # - ORIGINAL_DESTINATION: Backend host is selected
3077 # based on the client connection metadata, i.e., connections are opened to
3078 # the same address as the destination address of the incoming connection
3079 # before the connection was redirected to the load balancer.
3080 # - MAGLEV: used as a drop in replacement for the ring hash
3081 # load balancer. Maglev is not as stable as ring hash but has faster table
3082 # lookup build times and host selection times. For more information about
3083 # Maglev, see Maglev:
3084 # A Fast and Reliable Software Network Load Balancer.
3085 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
3086 # Load Balancing using weights computed from Backend reported Custom Metrics.
3087 # If set, the Backend Service responses are expected to contain non-standard
3088 # HTTP response header field Endpoint-Load-Metrics. The reported
3089 # metrics to use for computing the weights are specified via thecustomMetrics field.
3090 #
3091 # This field is applicable to either:
3092 # - A regional backend service with the service protocol set to HTTP,
3093 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3094 # INTERNAL_MANAGED.
3095 # - A global backend service with the
3096 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
3097 # EXTERNAL_MANAGED.
3098 #
3099 #
3100 # If sessionAffinity is not configured—that is, if session
3101 # affinity remains at the default value of NONE—then the
3102 # default value for localityLbPolicy
3103 # is ROUND_ROBIN. If session affinity is set to a value other
3104 # than NONE,
3105 # then the default value for localityLbPolicy isMAGLEV.
3106 #
3107 # Only ROUND_ROBIN and RING_HASH are supported
3108 # when the backend service is referenced by a URL map that is bound to
3109 # target gRPC proxy that has validateForProxyless field set to true.
3110 #
3111 # localityLbPolicy cannot be specified with haPolicy.
3112 &quot;logConfig&quot;: { # The available logging options for the load balancer traffic served by this # This field denotes the logging options for the load balancer traffic served
3113 # by this backend service. If logging is enabled, logs will be exported to
3114 # Stackdriver.
3115 # backend service.
3116 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
3117 # traffic served by this backend service. The default value is false.
3118 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
3119 { # Determines which HTTP headers will be logged to Stackdriver.
3120 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3121 },
3122 ],
3123 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
3124 { # Determines which HTTP headers will be logged to Stackdriver.
3125 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3126 },
3127 ],
3128 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
3129 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
3130 # of optional fields you want to include in the logs. For example:
3131 # serverInstance, serverGkeDetails.cluster,
3132 # serverGkeDetails.pod.podNamespace
3133 &quot;A String&quot;,
3134 ],
3135 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
3136 # service. Configures whether all, none or a subset of optional fields
3137 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3138 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3139 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
3140 # service. The value of the field must be in [0, 1]. This configures the
3141 # sampling rate of requests to the load balancer where 1.0 means all logged
3142 # requests are reported and 0.0 means no logged requests are reported. The
3143 # default value is 1.0.
3144 },
3145 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
3146 # service. Duration is computed from the beginning of the stream until the
3147 # response has been completely processed, including all retries. A stream
3148 # that does not complete in this duration is closed.
3149 #
3150 # If not specified, there will be no timeout limit, i.e. the maximum
3151 # duration is infinite.
3152 #
3153 # This value can be overridden in the PathMatcher configuration of the
3154 # UrlMap that references this backend service.
3155 #
3156 # This field is only allowed when the loadBalancingScheme of
3157 # the backend service is INTERNAL_SELF_MANAGED.
3158 # as a count of seconds and fractions of seconds at nanosecond
3159 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3160 # or &quot;month&quot;. Range is approximately 10,000 years.
3161 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3162 # Durations less than one second are represented with a 0
3163 # `seconds` field and a positive `nanos` field. Must be from 0
3164 # to 999,999,999 inclusive.
3165 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3166 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3167 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3168 },
3169 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
3170 # controller and read by the backend RCTH
3171 &quot;a_key&quot;: &quot;A String&quot;,
3172 },
3173 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3174 # The name must be 1-63 characters long, and comply withRFC1035.
3175 # Specifically, the name must be 1-63 characters long and match the regular
3176 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3177 # character must be a lowercase letter, and all following characters must
3178 # be a dash, lowercase letter, or digit, except the last character, which
3179 # cannot be a dash.
3180 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
3181 #
3182 # This field must be set for Internal Passthrough Network Load Balancers when
3183 # the haPolicy is enabled, and for External Passthrough Network Load
3184 # Balancers when the haPolicy fastIpMove is enabled.
3185 #
3186 # This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
3187 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
3188 # Load Balancers.
3189 #
3190 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
3191 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
3192 # endpoints in the local zone.
3193 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
3194 # possible values are:
3195 #
3196 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
3197 # is disabled. The load balancer distributes new connections to all
3198 # healthy backend endpoints across all zones.
3199 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
3200 # enabled. The load balancer distributes new connections to all healthy
3201 # backend endpoints in the local zone only. If there are no healthy
3202 # backend endpoints in the local zone, the load balancer distributes
3203 # new connections to all backend endpoints in the local zone.
3204 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
3205 # enabled. The load balancer distributes new connections to all healthy
3206 # backend endpoints in the local zone only. If there aren&#x27;t enough
3207 # healthy backend endpoints in the local zone, the load balancer
3208 # distributes new connections to all healthy backend endpoints across all
3209 # zones.
3210 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
3211 # of healthy backend endpoints in a zone to the count of backend
3212 # endpoints in that same zone is equal to or above this threshold, the
3213 # load balancer distributes new connections to all healthy endpoints in
3214 # the local zone only. When the ratio of the count of healthy backend
3215 # endpoints in a zone to the count of backend endpoints in that same
3216 # zone is below this threshold, the load balancer distributes all new
3217 # connections to all healthy endpoints across all zones.
3218 },
3219 },
3220 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
3221 # the backend service.
3222 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
3223 # service.
3224 },
3225 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
3226 # load balancing pool of each individual proxy instance that processes the
3227 # traffic for the given backend service. If not set, this feature is
3228 # considered disabled.
3229 #
3230 # Results of the outlier detection algorithm (ejection of endpoints from the
3231 # load balancing pool and returning them back to the pool) are executed
3232 # independently by each proxy instance of the load balancer. In most cases,
3233 # more than one proxy instance handles the traffic received by a backend
3234 # service. Thus, it is possible that an unhealthy endpoint is detected and
3235 # ejected by only some of the proxies, and while this happens, other proxies
3236 # may continue to send requests to the same unhealthy endpoint until they
3237 # detect and eject the unhealthy endpoint.
3238 #
3239 # Applicable backend endpoints can be:
3240 #
3241 # - VM instances in an Instance Group
3242 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
3243 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
3244 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
3245 # Functions Services
3246 # - Private Service Connect NEGs, that resolve to
3247 # Google-managed regional API endpoints or managed services published using
3248 # Private Service Connect
3249 #
3250 #
3251 #
3252 # Applicable backend service types can be:
3253 #
3254 # - A global backend service with the loadBalancingScheme set to
3255 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
3256 # - A regional backend
3257 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
3258 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
3259 # supported for Serverless NEGs.
3260 #
3261 #
3262 #
3263 # Not supported when the backend service is referenced by a URL map that is
3264 # bound to target gRPC proxy that has validateForProxyless field set to true.
3265 # pool for the backend service.
3266 &quot;baseEjectionTime&quot;: { # A Duration represents a fixed-length span of time represented # The base time that a backend endpoint is ejected for. Defaults to 30000ms
3267 # or 30s.
3268 #
3269 # After a backend endpoint is returned back to the load balancing pool, it
3270 # can be ejected again in another ejection analysis. Thus, the total ejection
3271 # time is equal to the base ejection time multiplied by the number of times
3272 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
3273 # as a count of seconds and fractions of seconds at nanosecond
3274 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3275 # or &quot;month&quot;. Range is approximately 10,000 years.
3276 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3277 # Durations less than one second are represented with a 0
3278 # `seconds` field and a positive `nanos` field. Must be from 0
3279 # to 999,999,999 inclusive.
3280 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3281 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3282 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3283 },
3284 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
3285 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
3286 # return code qualifies as an error. Defaults to 5.
3287 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
3288 # connection errors that are mapped to one of those status codes) before a
3289 # consecutive gateway failure ejection occurs. Defaults to 3.
3290 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3291 # outlier status is detected through consecutive 5xx. This setting can be
3292 # used to disable ejection or to ramp it up slowly. Defaults to 0.
3293 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3294 # outlier status is detected through consecutive gateway failures. This
3295 # setting can be used to disable ejection or to ramp it up slowly. Defaults
3296 # to 100.
3297 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3298 # outlier status is detected through success rate statistics. This setting
3299 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
3300 #
3301 # Not supported when the backend service uses Serverless NEG.
3302 &quot;interval&quot;: { # A Duration represents a fixed-length span of time represented # Time interval between ejection analysis sweeps. This can result in both new
3303 # ejections and backend endpoints being returned to service. The interval is
3304 # equal to the number of seconds as defined in
3305 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
3306 # in outlierDetection.interval.nanos. Defaults to 1 second.
3307 # as a count of seconds and fractions of seconds at nanosecond
3308 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3309 # or &quot;month&quot;. Range is approximately 10,000 years.
3310 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3311 # Durations less than one second are represented with a 0
3312 # `seconds` field and a positive `nanos` field. Must be from 0
3313 # to 999,999,999 inclusive.
3314 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3315 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3316 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3317 },
3318 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
3319 # backend service that can be ejected if the ejection conditions are met.
3320 # Defaults to 50%.
3321 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
3322 # enough request volume to detect success rate outliers. If the number of
3323 # backend endpoints is fewer than this setting, outlier detection via success
3324 # rate statistics is not performed for any backend endpoint in the load
3325 # balancing pool. Defaults to 5.
3326 #
3327 # Not supported when the backend service uses Serverless NEG.
3328 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
3329 # (as defined by the interval duration above) to include this backend
3330 # endpoint in success rate based outlier detection. If the volume is lower
3331 # than this setting, outlier detection via success rate statistics is not
3332 # performed for that backend endpoint. Defaults to 100.
3333 #
3334 # Not supported when the backend service uses Serverless NEG.
3335 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
3336 # outlier ejection. The ejection threshold is the difference between the mean
3337 # success rate, and the product of this factor and the standard deviation of
3338 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
3339 # is divided by a thousand to get a double. That is, if the desired factor
3340 # is 1.9, the runtime value should be 1900. Defaults to 1900.
3341 #
3342 # Not supported when the backend service uses Serverless NEG.
3343 },
3344 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3345 # as part of resource payload.
3346 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3347 # Tag keys and values have the same definition as resource
3348 # manager tags. The field is allowed for INSERT
3349 # only. The keys/values to set on the resource should be specified in
3350 # either ID { : } or Namespaced format
3351 # { : }.
3352 # For example the following are valid inputs:
3353 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3354 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3355 # Note:
3356 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3357 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3358 &quot;a_key&quot;: &quot;A String&quot;,
3359 },
3360 },
3361 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
3362 # the backend. The default value is 80.
3363 # For internal passthrough Network Load Balancers and external passthrough
3364 # Network Load Balancers, omit port.
3365 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
3366 # communication to the backend VMs in that group. The
3367 # named port must be [defined on each backend instance
3368 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
3369 # This parameter has no meaning if the backends are NEGs. For internal
3370 # passthrough Network Load Balancers and external passthrough Network Load
3371 # Balancers, omit port_name.
3372 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
3373 # with backends.
3374 #
3375 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
3376 # depending on the chosen load balancer or Traffic Director configuration.
3377 # Refer to the documentation for the load balancers or for Traffic Director
3378 # for more information.
3379 #
3380 # Must be set to GRPC when the backend service is referenced by a URL map
3381 # that is bound to target gRPC proxy.
3382 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
3383 # resides. This field is not applicable to global backend services.
3384 # You must specify this field as part of the HTTP request URL. It is
3385 # not settable as a field in the request body.
3386 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
3387 # backend service.
3388 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
3389 # service. This field is applicable to a global backend service with the
3390 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3391 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
3392 &quot;awsV4Authentication&quot;: { # Contains the configurations necessary to generate a signature for access to # The configuration needed to generate a signature for access to private
3393 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
3394 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
3395 # private storage buckets that support Signature Version 4 for authentication.
3396 # The service name for generating the authentication header will always default
3397 # to &#x27;s3&#x27;.
3398 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
3399 # creating a backend that uses AWS v4 signature authentication, but will not
3400 # be returned as part of the configuration when queried with a REST API GET
3401 # request.
3402 #
3403 # @InputOnly
3404 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
3405 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
3406 # keep track of different iterations of your access key.
3407 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
3408 # the name of the region your cloud uses to host your origin. For example,
3409 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
3410 },
3411 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
3412 # that describes how clients should authenticate with this service&#x27;s
3413 # backends.
3414 #
3415 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
3416 # to INTERNAL_SELF_MANAGED.
3417 #
3418 # If left blank, communications are not encrypted.
3419 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
3420 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
3421 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
3422 # specified values, the communication continues. Otherwise, it fails. This
3423 # additional check enables the client to verify that the server is authorized
3424 # to run the requested service.
3425 #
3426 # Note that the contents of the server
3427 # certificate&#x27;s subjectAltName field are configured by the
3428 # Public Key Infrastructure which provisions server identities.
3429 #
3430 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
3431 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
3432 # mode).
3433 &quot;A String&quot;,
3434 ],
3435 },
3436 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3437 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
3438 #
3439 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
3440 # If set, lists of backends and health checks must be both empty.
3441 &quot;A String&quot;,
3442 ],
3443 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
3444 #
3445 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
3446 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
3447 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
3448 #
3449 # Only NONE and HEADER_FIELD are supported
3450 # when the backend service is referenced by a URL map that is bound to
3451 # target gRPC proxy that has validateForProxyless field set to true.
3452 #
3453 # For more details, see:
3454 # [Session
3455 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
3456 #
3457 # sessionAffinity cannot be specified with haPolicy.
3458 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
3459 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
3460 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3461 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3462 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3463 # as a count of seconds and fractions of seconds at nanosecond
3464 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3465 # or &quot;month&quot;. Range is approximately 10,000 years.
3466 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3467 # Durations less than one second are represented with a 0
3468 # `seconds` field and a positive `nanos` field. Must be from 0
3469 # to 999,999,999 inclusive.
3470 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3471 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3472 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3473 },
3474 },
3475 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
3476 # Currently this is applicable only for Internal TCP/UDP load balancing,
3477 # Internal HTTP(S) load balancing and Traffic Director.
3478 &quot;policy&quot;: &quot;A String&quot;,
3479 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
3480 # each service mesh client.
3481 #
3482 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
3483 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
3484 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
3485 # `INTERNAL_SELF_MANAGED`.
3486 #
3487 # `subset_size` is optional for Internal HTTP(S) load balancing
3488 # and required for Traffic Director.
3489 #
3490 # If you do not provide this value, Cloud Load Balancing will calculate it
3491 # dynamically to optimize the number of proxies/clients visible to each
3492 # backend and vice versa.
3493 #
3494 # Must be greater than 0. If `subset_size` is larger than the number of
3495 # backends/endpoints, then subsetting is disabled.
3496 },
3497 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
3498 # type of load balancer. For more information see,
3499 # Backend service settings.
3500 # The default is 30 seconds.
3501 # The full range of timeout values allowed goes from 1
3502 # through 2,147,483,647 seconds.
3503 #
3504 # This value can be overridden in the PathMatcher configuration of the
3505 # UrlMap that references this backend service.
3506 #
3507 # Not supported when the backend service is referenced by a URL map that is
3508 # bound to target gRPC proxy that has validateForProxyless field set to true.
3509 # Instead, use maxStreamDuration.
3510 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
3511 # when the backend protocol is SSL, HTTPS or HTTP2.
3512 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
3513 # networksecurity.googleapis.com namespace. Can be used in authenticating
3514 # TLS connections to the backend, as specified by the authenticationMode
3515 # field. Can only be specified if authenticationMode is not NONE.
3516 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
3517 #
3518 #
3519 # Use this property to configure the load balancer back-end to use
3520 # certificates and roots of trust provisioned by the Managed Workload
3521 # Identity system.
3522 #
3523 # The `identity` property is the
3524 # fully-specified SPIFFE ID to use in the SVID presented by the Load
3525 # Balancer Workload.
3526 #
3527 # The SPIFFE ID must be a resource starting with the
3528 # `trustDomain` property value, followed by the path to the Managed
3529 # Workload Identity.
3530 #
3531 # Supported SPIFFE ID format:
3532 #
3533 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
3534 #
3535 #
3536 # The Trust Domain within the Managed Identity must refer to a valid
3537 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
3538 # will be inherited from the Workload Identity Pool.
3539 #
3540 # Restrictions:
3541 #
3542 # - If you set the `identity` property, you cannot manually set
3543 # the following fields:
3544 # - tlsSettings.sni
3545 # - tlsSettings.subjectAltNames
3546 # - tlsSettings.authenticationConfig
3547 #
3548 #
3549 # When defining a `identity` for a RegionBackendServices, the
3550 # corresponding Workload Identity Pool must have a ca_pool
3551 # configured in the same region.
3552 #
3553 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
3554 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
3555 # balancer sends this string as the SNI hostname in the TLS connection to
3556 # the backend, and requires that this string match a Subject Alternative
3557 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
3558 # NEG backend, if the SNI is specified here, the load balancer uses it
3559 # regardless of whether the Regional Internet NEG is specified with FQDN or
3560 # IP address and port. When both sni and subjectAltNames[] are specified,
3561 # the load balancer matches the backend certificate&#x27;s SAN only to
3562 # subjectAltNames[].
3563 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
3564 # verifies during a TLS handshake with the backend. When the server
3565 # presents its X.509 certificate to the Load Balancer, the Load Balancer
3566 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
3567 # match one of the subjectAltNames in the list. This field is limited to 5
3568 # entries. When both sni and subjectAltNames[] are specified, the load
3569 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
3570 { # A Subject Alternative Name that the load balancer matches against the SAN
3571 # field in the TLS certificate provided by the backend, specified as either
3572 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
3573 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
3574 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
3575 },
3576 ],
3577 },
3578 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
3579 {
3580 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
3581 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
3582 # and ForwardingRule.
3583 },
3584 ],
3585 }
3586
3587 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3588 that if you must retry your request, the server will know to ignore the
3589 request if it has already been completed.
3590
3591 For example, consider a situation where you make an initial request and
3592 the request times out. If you make the request again with the same
3593 request ID, the server can check if original operation with the same
3594 request ID was received, and if so, will ignore the second request. This
3595 prevents clients from accidentally creating duplicate commitments.
3596
3597 The request ID must be
3598 a valid UUID with the exception that zero UUID is not supported
3599 (00000000-0000-0000-0000-000000000000).
3600 x__xgafv: string, V1 error format.
3601 Allowed values
3602 1 - v1 error format
3603 2 - v2 error format
3604
3605 Returns:
3606 An object of the form:
3607
3608 { # Represents an Operation resource.
3609 #
3610 # Google Compute Engine has three Operation resources:
3611 #
3612 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
3613 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
3614 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
3615 #
3616 # You can use an operation resource to manage asynchronous API requests.
3617 # For more information, readHandling
3618 # API responses.
3619 #
3620 # Operations can be global, regional or zonal.
3621 #
3622 # - For global operations, use the `globalOperations`
3623 # resource.
3624 # - For regional operations, use the
3625 # `regionOperations` resource.
3626 # - For zonal operations, use
3627 # the `zoneOperations` resource.
3628 #
3629 #
3630 #
3631 # For more information, read
3632 # Global, Regional, and Zonal Resources.
3633 #
3634 # Note that completed Operation resources have a limited
3635 # retention period.
3636 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3637 # Not present otherwise.
3638 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3639 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3640 # set when the operation is created.
3641 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3642 # text format.
3643 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3644 # this field will be populated.
3645 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3646 # operation.
3647 {
3648 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3649 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3650 # details. There is a set of defined message types to use for providing
3651 # details.The syntax depends on the error code. For example,
3652 # QuotaExceededInfo will have details when the error code is
3653 # QUOTA_EXCEEDED.
3654 {
3655 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3656 #
3657 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3658 # is not enabled:
3659 #
3660 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3661 # &quot;domain&quot;: &quot;googleapis.com&quot;
3662 # &quot;metadata&quot;: {
3663 # &quot;resource&quot;: &quot;projects/123&quot;,
3664 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3665 # }
3666 # }
3667 #
3668 # This response indicates that the pubsub.googleapis.com API is not enabled.
3669 #
3670 # Example of an error that is returned when attempting to create a Spanner
3671 # instance in a region that is out of stock:
3672 #
3673 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3674 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3675 # &quot;metadata&quot;: {
3676 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3677 # }
3678 # }
3679 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3680 # is typically the registered service name of the tool or product that
3681 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3682 # generated by some common infrastructure, the error domain must be a
3683 # globally unique value that identifies the infrastructure. For Google API
3684 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3685 &quot;metadatas&quot;: { # Additional structured details about this error.
3686 #
3687 # Keys must match a regular expression of `a-z+` but should
3688 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3689 # length. When identifying the current value of an exceeded limit, the units
3690 # should be contained in the key, not the value. For example, rather than
3691 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3692 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3693 # instances that can be created in a single (batch) request.
3694 &quot;a_key&quot;: &quot;A String&quot;,
3695 },
3696 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3697 # proximate cause of the error. Error reasons are unique within a particular
3698 # domain of errors. This should be at most 63 characters and match a
3699 # regular expression of `A-Z+[A-Z0-9]`, which represents
3700 # UPPER_SNAKE_CASE.
3701 },
3702 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3703 #
3704 # For example, if a quota check failed with an error indicating the calling
3705 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3706 # directly to the right place in the developer console to flip the bit.
3707 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3708 { # Describes a URL link.
3709 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3710 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3711 },
3712 ],
3713 },
3714 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3715 # which can be attached to an RPC error.
3716 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3717 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3718 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3719 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3720 },
3721 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3722 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3723 &quot;a_key&quot;: &quot;A String&quot;,
3724 },
3725 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3726 # type or metric.
3727 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3728 # or metric.
3729 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3730 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3731 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3732 },
3733 },
3734 ],
3735 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3736 # This property is optional.
3737 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3738 },
3739 ],
3740 },
3741 &quot;getVersionOperationMetadata&quot;: {
3742 &quot;inlineSbomInfo&quot;: {
3743 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3744 # appropriate identifiers.
3745 &quot;a_key&quot;: &quot;A String&quot;,
3746 },
3747 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3748 # identifiers.
3749 &quot;a_key&quot;: &quot;A String&quot;,
3750 },
3751 },
3752 },
3753 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3754 # message that was returned, such as `NOT FOUND`.
3755 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3756 # status code that was returned. For example, a `404` means the
3757 # resource was not found.
3758 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3759 # defined by the server.
3760 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3761 # This value is inRFC3339
3762 # text format.
3763 &quot;instancesBulkInsertOperationMetadata&quot;: {
3764 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3765 # Example key: zones/us-central1-a
3766 &quot;a_key&quot;: {
3767 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3768 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3769 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3770 # error.
3771 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3772 # if the flow is rolling forward or rolling back.
3773 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3774 },
3775 },
3776 },
3777 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3778 # Operation resources.
3779 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3780 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3781 # group of operations results from a `bulkInsert` API request.
3782 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3783 # `update`, or `delete`, and so on.
3784 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3785 # There is no requirement that this be linear or support any granularity of
3786 # operations. This should not be used to guess when the operation will be
3787 # complete. This number should monotonically increase as the operation
3788 # progresses.
3789 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3790 # applicable when performing regional operations.
3791 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3792 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3793 # this field will contain information on all underlying zonal actions and
3794 # their state.
3795 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3796 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3797 # Example key: zones/us-central1-a
3798 &quot;a_key&quot;: {
3799 &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
3800 # populated.
3801 # different programming environments, including REST APIs and RPC APIs. It is
3802 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3803 # three pieces of data: error code, error message, and error details.
3804 #
3805 # You can find out more about this error model and how to work with it in the
3806 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3807 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3808 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3809 # message types for APIs to use.
3810 {
3811 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3812 },
3813 ],
3814 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3815 # user-facing error message should be localized and sent in the
3816 # google.rpc.Status.details field, or localized by the client.
3817 },
3818 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3819 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3820 },
3821 },
3822 },
3823 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3824 # This value is inRFC3339
3825 # text format.
3826 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3827 # following:
3828 # `PENDING`, `RUNNING`, or `DONE`.
3829 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3830 # operation.
3831 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3832 # of the target resource.
3833 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3834 # operations related to creating a snapshot, this points to the disk
3835 # that the snapshot was created from.
3836 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3837 # `[email protected]` or
3838 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3839 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3840 # operation, this field will be populated.
3841 {
3842 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3843 # Engine returns NO_RESULTS_ON_PAGE if there
3844 # are no results in the response.
3845 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3846 # value format. For example:
3847 #
3848 # &quot;data&quot;: [
3849 # {
3850 # &quot;key&quot;: &quot;scope&quot;,
3851 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3852 # }
3853 {
3854 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3855 # returned. For example, for warnings where there are no results in a list
3856 # request for a particular zone, this key might be scope and
3857 # the key value might be the zone name. Other examples might be a key
3858 # indicating a deprecated resource and a suggested replacement, or a
3859 # warning about invalid network settings (for example, if an instance
3860 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3861 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3862 },
3863 ],
3864 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3865 },
3866 ],
3867 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3868 # applicable when performing per-zone operations.
3869 }</pre>
3870 </div>
3871
3872 <div class="method">
3873 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
3874 <pre>Retrieves the list of regional BackendService resources available to the
3875 specified project in the given region.
3876
3877 Args:
3878 project: string, Project ID for this request. (required)
3879 region: string, Name of the region scoping this request. (required)
3880 filter: string, A filter expression that filters resources listed in the response. Most
3881 Compute resources support two types of filter expressions:
3882 expressions that support regular expressions and expressions that follow
3883 API improvement proposal AIP-160.
3884 These two types of filter expressions cannot be mixed in one request.
3885
3886 If you want to use AIP-160, your expression must specify the field name, an
3887 operator, and the value that you want to use for filtering. The value
3888 must be a string, a number, or a boolean. The operator
3889 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3890
3891 For example, if you are filtering Compute Engine instances, you can
3892 exclude instances named `example-instance` by specifying
3893 `name != example-instance`.
3894
3895 The `:*` comparison can be used to test whether a key has been defined.
3896 For example, to find all objects with `owner` label use:
3897 ```
3898 labels.owner:*
3899 ```
3900
3901 You can also filter nested fields. For example, you could specify
3902 `scheduling.automaticRestart = false` to include instances only
3903 if they are not scheduled for automatic restarts. You can use filtering
3904 on nested fields to filter based onresource labels.
3905
3906 To filter on multiple expressions, provide each separate expression within
3907 parentheses. For example:
3908 ```
3909 (scheduling.automaticRestart = true)
3910 (cpuPlatform = &quot;Intel Skylake&quot;)
3911 ```
3912 By default, each expression is an `AND` expression. However, you
3913 can include `AND` and `OR` expressions explicitly.
3914 For example:
3915 ```
3916 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3917 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3918 (scheduling.automaticRestart = true)
3919 ```
3920
3921 If you want to use a regular expression, use the `eq` (equal) or `ne`
3922 (not equal) operator against a single un-parenthesized expression with or
3923 without quotes or against multiple parenthesized expressions. Examples:
3924
3925 `fieldname eq unquoted literal`
3926 `fieldname eq &#x27;single quoted literal&#x27;`
3927 `fieldname eq &quot;double quoted literal&quot;`
3928 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3929
3930 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3931 The literal value must match the entire field.
3932
3933 For example, to filter for instances that do not end with name &quot;instance&quot;,
3934 you would use `name ne .*instance`.
3935
3936 You cannot combine constraints on multiple fields using regular
3937 expressions.
3938 maxResults: integer, The maximum number of results per page that should be returned.
3939 If the number of available results is larger than `maxResults`,
3940 Compute Engine returns a `nextPageToken` that can be used to get
3941 the next page of results in subsequent list requests. Acceptable values are
3942 `0` to `500`, inclusive. (Default: `500`)
3943 orderBy: string, Sorts list results by a certain order. By default, results
3944 are returned in alphanumerical order based on the resource name.
3945
3946 You can also sort results in descending order based on the creation
3947 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3948 results based on the `creationTimestamp` field in
3949 reverse chronological order (newest result first). Use this to sort
3950 resources like operations so that the newest operation is returned first.
3951
3952 Currently, only sorting by `name` or
3953 `creationTimestamp desc` is supported.
3954 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3955 `nextPageToken` returned by a previous list request to get
3956 the next page of results.
3957 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3958 of failure. The default value is false.
3959
3960 For example, when partial success behavior is enabled, aggregatedList for a
3961 single zone scope either returns all resources in the zone or no resources,
3962 with an error code.
3963 x__xgafv: string, V1 error format.
3964 Allowed values
3965 1 - v1 error format
3966 2 - v2 error format
3967
3968 Returns:
3969 An object of the form:
3970
3971 { # Contains a list of BackendService resources.
3972 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3973 &quot;items&quot;: [ # A list of BackendService resources.
3974 { # Represents a Backend Service resource.
3975 #
3976 # A backend service defines how Google Cloud load balancers distribute traffic.
3977 # The backend service configuration contains a set of values, such as the
3978 # protocol used to connect to backends, various distribution and session
3979 # settings, health checks, and timeouts. These settings provide fine-grained
3980 # control over how your load balancer behaves. Most of the settings have
3981 # default values that allow for easy configuration if you need to get started
3982 # quickly.
3983 #
3984 # Backend services in Google Compute Engine can be either regionally or
3985 # globally scoped.
3986 #
3987 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
3988 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
3989 #
3990 # For more information, seeBackend
3991 # Services.
3992 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
3993 # Load Balancers and Traffic Director and requires
3994 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
3995 #
3996 # If set to 0, the cookie is non-persistent and lasts only until
3997 # the end of the browser session (or equivalent). The maximum allowed value
3998 # is two weeks (1,209,600).
3999 #
4000 # Not supported when the backend service is referenced by a URL map that is
4001 # bound to target gRPC proxy that has validateForProxyless field set to true.
4002 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
4003 { # Message containing information of one individual backend.
4004 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
4005 # handle additional traffic or is fully loaded. For usage guidelines, see
4006 # Connection balancing mode.
4007 #
4008 # Backends must use compatible balancing modes. For more information, see
4009 # Supported balancing modes and target capacity settings and
4010 # Restrictions and guidance for instance groups.
4011 #
4012 # Note: Currently, if you use the API to configure incompatible balancing
4013 # modes, the configuration might be accepted even though it has no impact
4014 # and is ignored. Specifically, Backend.maxUtilization is ignored when
4015 # Backend.balancingMode is RATE. In the future, this incompatible combination
4016 # will be rejected.
4017 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
4018 # mode.
4019 # The default value is 1, which means the group serves up to
4020 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
4021 # completely drained, offering 0% of its available capacity. The valid ranges
4022 # are 0.0 and [0.1,1.0].
4023 # You cannot configure a setting larger than 0 and smaller than0.1.
4024 # You cannot configure a setting of 0 when there is only one
4025 # backend attached to the backend service.
4026 #
4027 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
4028 # internet NEGs, regional serverless NEGs, and PSC NEGs.
4029 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
4030 # BalancingMode.
4031 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
4032 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
4033 # Monitoring, but is not used for load balancing.
4034 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
4035 # balancing mode. The valid range is [0.0, 1.0].
4036 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
4037 # long and match the regular expression
4038 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
4039 # first character must be a lowercase letter, and all following
4040 # characters must be a dash, period, underscore, lowercase letter, or
4041 # digit, except the last character, which cannot be a dash, period, or
4042 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
4043 # field can only be used for a global or regional backend service with the
4044 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
4045 },
4046 ],
4047 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4048 # create the resource.
4049 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
4050 # failover backend can be configured for a given BackendService.
4051 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
4052 # group or network endpoint
4053 # group (NEG) resource. To determine what types of backends a load
4054 # balancer supports, see the [Backend services
4055 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
4056 #
4057 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
4058 # or NEG. Partial URLs are not supported.
4059 #
4060 # If haPolicy is specified, backends must refer to NEG resources of type
4061 # GCE_VM_IP.
4062 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
4063 # guidelines, seeConnection
4064 # balancing mode and Utilization
4065 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
4066 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
4067 # guidelines, seeConnection
4068 # balancing mode and Utilization
4069 # balancing mode.
4070 #
4071 # Not available if the backend&#x27;s balancingMode isRATE.
4072 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
4073 # For usage guidelines, seeConnection
4074 # balancing mode and Utilization
4075 # balancing mode.
4076 #
4077 # Not available if the backend&#x27;s balancingMode isRATE.
4078 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
4079 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
4080 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
4081 # Not available if backend&#x27;s balancingMode is RATE
4082 # or CONNECTION.
4083 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
4084 # Not available if backend&#x27;s balancingMode is RATE
4085 # or CONNECTION.
4086 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
4087 # usage guidelines, seeRate
4088 # balancing mode and Utilization
4089 # balancing mode.
4090 #
4091 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4092 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
4093 # guidelines, seeRate
4094 # balancing mode and Utilization
4095 # balancing mode.
4096 #
4097 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4098 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
4099 # guidelines, seeRate
4100 # balancing mode and Utilization
4101 # balancing mode.
4102 #
4103 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4104 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
4105 #
4106 # For usage guidelines, seeUtilization
4107 # balancing mode.
4108 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
4109 # the backend.
4110 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
4111 },
4112 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
4113 # sending traffic to backends with default preference. The possible values
4114 # are:
4115 #
4116 # - PREFERRED: Backends with this preference level will be
4117 # filled up to their capacity limits first, based on RTT.
4118 # - DEFAULT: If preferred backends don&#x27;t have enough
4119 # capacity, backends in this layer would be used and traffic would be
4120 # assigned based on the load balancing algorithm you use. This is the
4121 # default
4122 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
4123 # Attachment).
4124 # e.g.
4125 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
4126 # for Cloud Run service.
4127 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
4128 # for PSC Service Attachment.
4129 &quot;trafficDuration&quot;: &quot;A String&quot;,
4130 },
4131 ],
4132 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
4133 # specified load balancer types.
4134 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
4135 # Pragma or Authorization headers. Up to 5 headers can be specified.
4136 # The cache is bypassed for all cdnPolicy.cacheMode settings.
4137 { # Bypass the cache when the specified request headers are present,
4138 # e.g. Pragma or Authorization headers. Values are case insensitive.
4139 # The presence of such a header overrides the cache_mode setting.
4140 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
4141 # Values are case-insensitive.
4142 },
4143 ],
4144 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
4145 # CDN.
4146 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
4147 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
4148 &quot;A String&quot;,
4149 ],
4150 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
4151 # The name=value pair will be used in the cache key Cloud CDN generates.
4152 &quot;A String&quot;,
4153 ],
4154 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
4155 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
4156 # query_string_whitelist and query_string_blacklist. If neither is set, the
4157 # entire query string will be included. If false, the query string will be
4158 # excluded from the cache key entirely.
4159 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
4160 # parameters will be included. Either specify query_string_whitelist or
4161 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
4162 # not treated as delimiters.
4163 &quot;A String&quot;,
4164 ],
4165 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
4166 # parameters will be excluded. Either specify query_string_whitelist or
4167 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
4168 # not treated as delimiters.
4169 &quot;A String&quot;,
4170 ],
4171 },
4172 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
4173 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
4174 # headers to cache content. Responses without these headers will not be
4175 # cached at Google&#x27;s edge, and will require a full trip to the origin on
4176 # every request, potentially impacting performance and increasing load on
4177 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
4178 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
4179 # Warning: this may result in Cloud CDN caching private,
4180 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
4181 # including common image formats, media (video and audio), and web assets
4182 # (JavaScript and CSS). Requests and responses that are marked as
4183 # uncacheable, as well as dynamic content (including HTML), will not be
4184 # cached.
4185 #
4186 # If no value is provided for cdnPolicy.cacheMode, it defaults
4187 # to CACHE_ALL_STATIC.
4188 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
4189 # used to clamp the max-age (or Expires) value sent to the client. With
4190 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
4191 # response max-age directive, along with a &quot;public&quot; directive. For
4192 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
4193 # from the origin (if specified), or else sets the response max-age
4194 # directive to the lesser of the client_ttl and default_ttl, and also
4195 # ensures a &quot;public&quot; cache-control directive is present.
4196 # If a client TTL is not specified, a default value (1 hour) will be used.
4197 # The maximum allowed value is 31,622,400s (1 year).
4198 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
4199 # responses that do not have an existing valid TTL (max-age or s-maxage).
4200 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4201 # The value of defaultTTL cannot be set to a value greater than that of
4202 # maxTTL, but can be equal.
4203 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
4204 # will overwrite the TTL set in all responses. The maximum allowed value is
4205 # 31,622,400s (1 year), noting that infrequently accessed objects may be
4206 # evicted from the cache before the defined TTL.
4207 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
4208 # origin.
4209 # Cache directives that attempt to set a max-age or s-maxage higher than
4210 # this, or an Expires header more than maxTTL seconds in the future will
4211 # be capped at the value of maxTTL, as if it were the value of an
4212 # s-maxage Cache-Control directive.
4213 # Headers sent to the client will not be modified.
4214 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4215 # The maximum allowed value is 31,622,400s (1 year), noting that
4216 # infrequently accessed objects may be evicted from the cache before
4217 # the defined TTL.
4218 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
4219 # to apply fine-grained caching for common errors or redirects.
4220 # This can reduce the load on your origin and improve end-user
4221 # experience by reducing response latency.
4222 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
4223 # negative caching applies to responses with the specified response code
4224 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
4225 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
4226 # to all responses with the specified response code, and override any
4227 # caching headers.
4228 # By default, Cloud CDN will apply the following default TTLs to these
4229 # status codes:
4230 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
4231 # HTTP 404 (Not Found), 410 (Gone),
4232 # 451 (Unavailable For Legal Reasons): 120s
4233 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
4234 # These defaults can be overridden in negative_caching_policy.
4235 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
4236 # negative_caching must be enabled to configure negative_caching_policy.
4237 # Omitting the policy and leaving negative_caching enabled will use
4238 # Cloud CDN&#x27;s default cache TTLs.
4239 # Note that when specifying an explicit negative_caching_policy, you
4240 # should take care to specify a cache TTL for all response codes
4241 # that you wish to cache. Cloud CDN will not apply any default
4242 # negative caching when a policy exists.
4243 { # Specify CDN TTLs for response error codes.
4244 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
4245 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
4246 # specified as values, and you cannot specify a status code more than
4247 # once.
4248 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
4249 # corresponding status code.
4250 # The maximum allowed value is 1800s (30 minutes), noting that
4251 # infrequently accessed objects may be evicted from the cache before the
4252 # defined TTL.
4253 },
4254 ],
4255 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
4256 # requests into a small number of requests to the origin.
4257 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
4258 # content with the origin, or when an error is encountered when refreshing
4259 # the cache.
4260 # This setting defines the default &quot;max-stale&quot; duration for any cached
4261 # responses that do not specify a max-stale directive. Stale responses that
4262 # exceed the TTL configured here will not be served. The default limit
4263 # (max-stale) is 86400s (1 day), which will allow stale content to be
4264 # served up to this limit beyond the max-age (or s-maxage) of a cached
4265 # response.
4266 # The maximum allowed value is 604800 (1 week).
4267 # Set this to zero (0) to disable serve-while-stale.
4268 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
4269 # considered fresh. After this time period, the response will be
4270 # revalidated before being served. Defaults to 1hr (3600s). When serving
4271 # responses to signed URL requests, Cloud CDN will internally behave as
4272 # though all responses from this backend had a &quot;Cache-Control:
4273 # public, max-age=[TTL]&quot; header, regardless of any existing
4274 # Cache-Control header. The actual headers served in responses will not be
4275 # altered.
4276 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
4277 &quot;A String&quot;,
4278 ],
4279 },
4280 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
4281 # backend service.
4282 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
4283 # as a count of seconds and fractions of seconds at nanosecond
4284 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4285 # or &quot;month&quot;. Range is approximately 10,000 years.
4286 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4287 # Durations less than one second are represented with a 0
4288 # `seconds` field and a positive `nanos` field. Must be from 0
4289 # to 999,999,999 inclusive.
4290 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4291 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4292 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4293 },
4294 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
4295 # there is no limit.
4296 #
4297 # Not supported when the backend service is referenced by a URL map that is
4298 # bound to target gRPC proxy that has validateForProxyless field set to true.
4299 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
4300 # not specified, there is no limit.
4301 #
4302 # Not supported when the backend service is referenced by a URL map that is
4303 # bound to target gRPC proxy that has validateForProxyless field set to true.
4304 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
4305 # service. If not specified, there is no limit.
4306 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
4307 # This parameter is respected by both the HTTP/1.1 and HTTP/2
4308 # implementations. If not specified, there is no limit. Setting this
4309 # parameter to 1 will effectively disable keep alive.
4310 #
4311 # Not supported when the backend service is referenced by a URL map that is
4312 # bound to target gRPC proxy that has validateForProxyless field set to true.
4313 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
4314 # not specified, the default is 1.
4315 #
4316 # Not supported when the backend service is referenced by a URL map that is
4317 # bound to target gRPC proxy that has validateForProxyless field set to true.
4318 },
4319 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
4320 # the client&#x27;s Accept-Encoding header.
4321 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
4322 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
4323 # instance. For supported load balancers and protocols, as described inEnabling
4324 # connection draining.
4325 },
4326 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
4327 # tracking policy settings are only available for external passthrough
4328 # Network Load Balancers and internal passthrough Network Load Balancers.
4329 #
4330 # connectionTrackingPolicy cannot be specified with haPolicy.
4331 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
4332 # value is DEFAULT_FOR_PROTOCOL.
4333 #
4334 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
4335 # persist on unhealthy backends only for connection-oriented protocols
4336 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
4337 # Affinity is configured for 5-tuple. They do not persist forUDP.
4338 #
4339 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
4340 # the existing connections on the unhealthy backend are never persisted on
4341 # the unhealthy backend. They are always diverted to newly selected healthy
4342 # backends (unless all backends are unhealthy).
4343 #
4344 # If set to ALWAYS_PERSIST, existing connections always
4345 # persist on unhealthy backends regardless of protocol and session
4346 # affinity. It is generally not recommended to use this mode overriding the
4347 # default.
4348 #
4349 # For more details, see [Connection Persistence for Network Load
4350 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
4351 # and [Connection Persistence for Internal TCP/UDP Load
4352 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
4353 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
4354 # Balancers. This option is not available publicly.
4355 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
4356 # matching traffic (in seconds).
4357 #
4358 # For internal passthrough Network Load Balancers:
4359 #
4360 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
4361 # - It can be set only if Connection Tracking is less than 5-tuple
4362 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
4363 # Mode is PER_SESSION).
4364 #
4365 #
4366 #
4367 # For external passthrough Network Load Balancers the default is 60
4368 # seconds. This option is not available publicly.
4369 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
4370 # options:
4371 #
4372 # - PER_CONNECTION: This is the default mode. The Connection
4373 # Tracking is performed as per the Connection Key (default Hash Method) for
4374 # the specific protocol.
4375 # - PER_SESSION: The Connection Tracking is performed as per
4376 # the configured Session Affinity. It matches the configured Session
4377 # Affinity.
4378 #
4379 #
4380 #
4381 # For more details, see [Tracking Mode for Network Load
4382 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
4383 # and [Tracking Mode for Internal TCP/UDP Load
4384 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
4385 },
4386 &quot;consistentHash&quot;: { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session
4387 # affinity based on HTTP headers, cookies or other properties. This load
4388 # balancing policy is applicable only for HTTP connections. The affinity to a
4389 # particular destination host will be lost when one or more hosts are
4390 # added/removed from the destination service. This field specifies parameters
4391 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
4392 #
4393 # This field is applicable to either:
4394 #
4395 # - A regional backend service with the service protocol set to HTTP,
4396 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
4397 # INTERNAL_MANAGED.
4398 # - A global backend service with the
4399 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
4400 &quot;httpCookie&quot;: { # The information about the HTTP Cookie on which the hash function is based # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
4401 # be used as the hash key for the consistent hash load balancer. If the
4402 # cookie is not present, it will be generated. This field is applicable if
4403 # the sessionAffinity is set to HTTP_COOKIE.
4404 #
4405 # Not supported when the backend service is referenced by a URL map that is
4406 # bound to target gRPC proxy that has validateForProxyless field set to true.
4407 # for load balancing policies that use a consistent hash.
4408 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
4409 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
4410 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
4411 # as a count of seconds and fractions of seconds at nanosecond
4412 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4413 # or &quot;month&quot;. Range is approximately 10,000 years.
4414 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4415 # Durations less than one second are represented with a 0
4416 # `seconds` field and a positive `nanos` field. Must be from 0
4417 # to 999,999,999 inclusive.
4418 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4419 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4420 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4421 },
4422 },
4423 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
4424 # applicable if the sessionAffinity is set toHEADER_FIELD.
4425 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
4426 # 1024. Larger ring sizes result in more granular load distributions. If the
4427 # number of hosts in the load balancing pool is larger than the ring size,
4428 # each host will be assigned a single virtual node.
4429 },
4430 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4431 # text format.
4432 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
4433 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
4434 # locality_lb_policy.
4435 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
4436 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
4437 # long and match the regular expression
4438 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
4439 # first character must be a lowercase letter, and all following
4440 # characters must be a dash, period, underscore, lowercase letter, or
4441 # digit, except the last character, which cannot be a dash, period, or
4442 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
4443 # field can only be used for a global or regional backend service with the
4444 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
4445 },
4446 ],
4447 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
4448 # custom
4449 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
4450 &quot;A String&quot;,
4451 ],
4452 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
4453 # custom
4454 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
4455 &quot;A String&quot;,
4456 ],
4457 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4458 # create the resource.
4459 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
4460 # backend service with dynamic forwarding feature which together with Service
4461 # Extension allows customized and complex routing logic.
4462 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
4463 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
4464 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
4465 },
4466 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
4467 # service. Some ranges are restricted: Restricted
4468 # ranges.
4469 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
4470 },
4471 },
4472 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
4473 # this backend service.
4474 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
4475 # global external Application Load Balancer.
4476 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
4477 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
4478 #
4479 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
4480 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
4481 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
4482 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
4483 # externalManagedMigrationTestingPercentage.
4484 #
4485 # Rolling back a migration requires the states to be set in reverse order. So
4486 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
4487 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
4488 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
4489 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
4490 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
4491 # external Application Load Balancer.
4492 #
4493 # The value of this field must be in the range [0, 100].
4494 #
4495 # Session affinity options will slightly affect this routing behavior, for
4496 # more details, see:Session
4497 # Affinity.
4498 #
4499 # This value can only be set if the loadBalancingScheme in the BackendService
4500 # is set to EXTERNAL (when using the classic Application Load Balancer) and
4501 # the migration state is TEST_BY_PERCENTAGE.
4502 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
4503 # as a backup (failover) backend.
4504 # For load balancers that have configurable failover:
4505 # [Internal passthrough Network Load
4506 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4507 # and [external passthrough Network Load
4508 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4509 #
4510 # failoverPolicy cannot be specified with haPolicy.
4511 # failover:
4512 # [Internal passthrough Network Load
4513 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4514 # and [external passthrough
4515 # Network Load
4516 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4517 # On failover or failback, this field indicates whether connection draining
4518 # will be honored. Google Cloud has a fixed connection draining timeout of
4519 # 10 minutes. A setting of true terminates existing TCP
4520 # connections to the active pool during failover and failback, immediately
4521 # draining traffic. A setting of false allows existing TCP
4522 # connections to persist, even on VMs no longer in the active pool, for up
4523 # to the duration of the connection draining timeout (10 minutes).
4524 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
4525 #
4526 # The default is false.
4527 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
4528 # load balancer are dropped when all primary and all backup backend VMs are
4529 # unhealthy.If set to false, connections are distributed
4530 # among all primary VMs when all primary and all backup backend VMs are
4531 # unhealthy.
4532 # For load balancers that have configurable
4533 # failover:
4534 # [Internal passthrough
4535 # Network Load
4536 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4537 # and [external passthrough
4538 # Network Load
4539 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4540 # The default is false.
4541 &quot;failoverRatio&quot;: 3.14, # The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
4542 # failover when the number of healthy primary VMs equals zero.
4543 # For all other values, the load balancer performs a failover when the
4544 # total number of healthy primary VMs is less than this ratio.
4545 # For load balancers that have configurable
4546 # failover:
4547 # [Internal TCP/UDP Load
4548 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4549 # and [external TCP/UDP Load
4550 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4551 },
4552 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
4553 # This field is used in optimistic locking. This field will be ignored when
4554 # inserting a BackendService. An up-to-date fingerprint must be provided in
4555 # order to update the BackendService, otherwise the request will
4556 # fail with error 412 conditionNotMet.
4557 #
4558 # To see the latest fingerprint, make a get() request to
4559 # retrieve a BackendService.
4560 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
4561 # Protocol Forwarding.
4562 #
4563 # The backends of this regional backend service must only specify zonal
4564 # network endpoint groups (NEGs) of type GCE_VM_IP.
4565 #
4566 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
4567 # regional backend service must set the network field. All zonal NEGs must
4568 # belong to the same network. However, individual NEGs can
4569 # belong to different subnetworks of that network.
4570 #
4571 # When haPolicy is specified, the set of attached network endpoints across
4572 # all backends comprise an High Availability domain from which one endpoint
4573 # is selected as the active endpoint (the leader) that receives all
4574 # traffic.
4575 #
4576 # haPolicy can be added only at backend service creation time. Once set up,
4577 # it cannot be deleted.
4578 #
4579 # Note that haPolicy is not for load balancing, and therefore cannot be
4580 # specified with sessionAffinity, connectionTrackingPolicy, and
4581 # failoverPolicy.
4582 #
4583 # haPolicy requires customers to be responsible for tracking backend
4584 # endpoint health and electing a leader among the healthy endpoints.
4585 # Therefore, haPolicy cannot be specified with healthChecks.
4586 #
4587 # haPolicy can only be specified for External Passthrough Network Load
4588 # Balancers and Internal Passthrough Network Load Balancers.
4589 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
4590 # achieve it.
4591 #
4592 # Supported values are:
4593 #
4594 # - DISABLED: Fast IP Move is disabled. You can only use the
4595 # haPolicy.leader API to update the leader.
4596 # - &gt;GARP_RA: Provides a method to very quickly define a new network
4597 # endpoint as the leader. This method is faster than updating the leader
4598 # using the haPolicy.leader API. Fast IP move works as follows: The VM
4599 # hosting the network endpoint that should become the new leader sends
4600 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
4601 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
4602 # temporarily associates the forwarding rule IP address with that VM, and
4603 # both new and in-flight packets are quickly delivered to that VM.
4604 #
4605 #
4606 #
4607 # Note the important properties of the Fast IP Move functionality:
4608 #
4609 # - The GARP/RA-initiated re-routing stays active for approximately 20
4610 # minutes. After triggering fast failover, you must also
4611 # appropriately set the haPolicy.leader.
4612 # - The new leader instance should continue to send GARP/RA packets
4613 # periodically every 10 seconds until at least 10 minutes after updating
4614 # the haPolicy.leader (but stop immediately if it is no longer the leader).
4615 # - After triggering a fast failover, we recommend that you wait at least
4616 # 3 seconds before sending another GARP/RA packet from a different VM
4617 # instance to avoid race conditions.
4618 # - Don&#x27;t send GARP/RA packets from different VM
4619 # instances at the same time. If multiple instances continue to send
4620 # GARP/RA packets, traffic might be routed to different destinations in an
4621 # alternating order. This condition ceases when a single instance
4622 # issues a GARP/RA packet.
4623 # - The GARP/RA request always takes priority over the leader API.
4624 # Using the haPolicy.leader API to change the leader to a different
4625 # instance will have no effect until the GARP/RA request becomes
4626 # inactive.
4627 # - The GARP/RA packets should follow the GARP/RA
4628 # Packet Specifications..
4629 # - When multiple forwarding rules refer to a regional backend service,
4630 # you need only send a GARP or RA packet for a single forwarding rule
4631 # virtual IP. The virtual IPs for all forwarding rules targeting the same
4632 # backend service will also be moved to the sender of the GARP or RA
4633 # packet.
4634 #
4635 #
4636 #
4637 # The following are the Fast IP Move limitations (that is, when fastIPMove
4638 # is not DISABLED):
4639 #
4640 # - Multiple forwarding rules cannot use the same IP address if one of
4641 # them refers to a regional backend service with fastIPMove.
4642 # - The regional backend service must set the network field, and all
4643 # NEGs must belong to that network. However, individual
4644 # NEGs can belong to different subnetworks of that network.
4645 # - The maximum number of network endpoints across all backends of a
4646 # backend service with fastIPMove is 32.
4647 # - The maximum number of backend services with fastIPMove that can have
4648 # the same network endpoint attached to one of its backends is 64.
4649 # - The maximum number of backend services with fastIPMove in a VPC in a
4650 # region is 64.
4651 # - The network endpoints that are attached to a backend of a backend
4652 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
4653 # - Traffic directed to the leader by a static route next hop will not be
4654 # redirected to a new leader by fast failover. Such traffic will only be
4655 # redirected once an haPolicy.leader update has taken effect. Only traffic
4656 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
4657 # fast failover.
4658 #
4659 #
4660 # haPolicy.fastIPMove can be set only at backend service creation time.
4661 # Once set, it cannot be updated.
4662 #
4663 # By default, fastIpMove is set to DISABLED.
4664 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
4665 # this service as the active endpoint (the leader) that receives all
4666 # traffic.
4667 #
4668 # When the leader changes, there is no connection draining to persist
4669 # existing connections on the old leader.
4670 #
4671 # You are responsible for selecting a suitable endpoint as the
4672 # leader. For example, preferring a healthy endpoint over unhealthy ones.
4673 # Note that this service does not track backend endpoint health, and
4674 # selects the configured leader unconditionally.
4675 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
4676 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
4677 # that the leader is attached to.
4678 #
4679 # The leader&#x27;s backendGroup must already be specified as a backend of
4680 # this backend service. Removing a backend that is designated as the
4681 # leader&#x27;s backendGroup is not permitted.
4682 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
4683 # designated as the leader.
4684 #
4685 # This network endpoint cannot be detached from the NEG specified in
4686 # the haPolicy.leader.backendGroup until the leader is updated with
4687 # another network endpoint, or the leader is removed from the haPolicy.
4688 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
4689 # instance must already be attached to the NEG specified in the
4690 # haPolicy.leader.backendGroup.
4691 #
4692 # The name must be 1-63 characters long, and comply with RFC1035.
4693 # Authorization requires the following IAM permission on the
4694 # specified resource instance: compute.instances.use
4695 },
4696 },
4697 },
4698 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
4699 # httpsHealthChecks (legacy) resource for health checking this backend
4700 # service. Not all backend services support legacy health checks. See
4701 # Load balancer guide. Currently, at most one health check can be
4702 # specified for each backend service. Backend services with
4703 # instance group or zonal NEG backends must have a health check unless
4704 # haPolicy is specified. Backend services with internet or serverless NEG
4705 # backends must not have a health check.
4706 #
4707 # healthChecks[] cannot be specified with haPolicy.
4708 &quot;A String&quot;,
4709 ],
4710 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
4711 # Not available for internal passthrough Network Load Balancers and external
4712 # passthrough Network Load Balancers.
4713 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
4714 # incoming requests.
4715 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
4716 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
4717 # For security reasons, this value cannot be retrieved via the API.
4718 # Instead, the SHA-256 hash of the value is returned in the
4719 # oauth2ClientSecretSha256 field.
4720 #
4721 # @InputOnly
4722 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
4723 },
4724 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4725 # defined by the server.
4726 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
4727 # from the client to the backend for proxyless gRPC).
4728 # The possible values are:
4729 #
4730 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
4731 # backend service (Instance Group, Managed Instance Group, Network Endpoint
4732 # Group), regardless of traffic from the client to the proxy. Only IPv4
4733 # health checks are used to check the health of the backends. This is the
4734 # default setting.
4735 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
4736 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
4737 # address).
4738 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
4739 # backend service (Instance Group, Managed Instance Group, Network Endpoint
4740 # Group), regardless of traffic from the client to the proxy. Only IPv6
4741 # health checks are used to check the health of the backends.
4742 #
4743 #
4744 #
4745 # This field is applicable to either:
4746 #
4747 # - Advanced global external Application Load Balancer (load balancing
4748 # scheme EXTERNAL_MANAGED),
4749 # - Regional external Application Load
4750 # Balancer,
4751 # - Internal proxy Network Load Balancer (load balancing
4752 # scheme INTERNAL_MANAGED),
4753 # - Regional internal Application Load
4754 # Balancer (load balancing scheme INTERNAL_MANAGED),
4755 # - Traffic
4756 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
4757 # INTERNAL_SELF_MANAGED).
4758 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
4759 # for backend services.
4760 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
4761 # created for one type of load balancer cannot be used with another.
4762 # For more information, refer toChoosing
4763 # a load balancer.
4764 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
4765 # preference. When you use localityLbPolicies, you must set at least one
4766 # value for either the localityLbPolicies[].policy or the
4767 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
4768 # value set in the localityLbPolicy field.
4769 #
4770 # For an example of how to use this field, seeDefine
4771 # a list of preferred policies.
4772 #
4773 # Caution: This field and its children are intended for use in a service mesh
4774 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
4775 # that have this configuration.
4776 { # Container for either a built-in LB policy supported by gRPC or Envoy or
4777 # a custom one implemented by the end user.
4778 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
4779 # deployed with the client.
4780 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
4781 # by a locally installed custom policy implementation.
4782 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
4783 #
4784 # The value should match the name of a custom implementation registered
4785 # on the gRPC clients. It should follow protocol buffer message naming
4786 # conventions and include the full path (for example,
4787 # myorg.CustomLbPolicy). The maximum length is 256 characters.
4788 #
4789 # Do not specify the same custom policy more than once for a
4790 # backend. If you do, the configuration is rejected.
4791 #
4792 # For an example of how to use this field, seeUse
4793 # a custom policy.
4794 },
4795 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
4796 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
4797 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
4798 # about these values, see the description of localityLbPolicy.
4799 #
4800 # Do not specify the same policy more than once for a
4801 # backend. If you do, the configuration is rejected.
4802 },
4803 },
4804 ],
4805 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
4806 # possible values are:
4807 #
4808 # - ROUND_ROBIN: This is a simple policy in which each healthy
4809 # backend is selected in round robin order. This is the default.
4810 # - LEAST_REQUEST: An O(1) algorithm which
4811 # selects two random healthy hosts and picks the host which has fewer active
4812 # requests.
4813 # - RING_HASH: The ring/modulo hash load balancer implements
4814 # consistent hashing to backends. The algorithm has the property that the
4815 # addition/removal of a host from a set of N hosts only affects 1/N of the
4816 # requests.
4817 # - RANDOM: The load balancer selects a random healthy
4818 # host.
4819 # - ORIGINAL_DESTINATION: Backend host is selected
4820 # based on the client connection metadata, i.e., connections are opened to
4821 # the same address as the destination address of the incoming connection
4822 # before the connection was redirected to the load balancer.
4823 # - MAGLEV: used as a drop in replacement for the ring hash
4824 # load balancer. Maglev is not as stable as ring hash but has faster table
4825 # lookup build times and host selection times. For more information about
4826 # Maglev, see Maglev:
4827 # A Fast and Reliable Software Network Load Balancer.
4828 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
4829 # Load Balancing using weights computed from Backend reported Custom Metrics.
4830 # If set, the Backend Service responses are expected to contain non-standard
4831 # HTTP response header field Endpoint-Load-Metrics. The reported
4832 # metrics to use for computing the weights are specified via thecustomMetrics field.
4833 #
4834 # This field is applicable to either:
4835 # - A regional backend service with the service protocol set to HTTP,
4836 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
4837 # INTERNAL_MANAGED.
4838 # - A global backend service with the
4839 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
4840 # EXTERNAL_MANAGED.
4841 #
4842 #
4843 # If sessionAffinity is not configured—that is, if session
4844 # affinity remains at the default value of NONE—then the
4845 # default value for localityLbPolicy
4846 # is ROUND_ROBIN. If session affinity is set to a value other
4847 # than NONE,
4848 # then the default value for localityLbPolicy isMAGLEV.
4849 #
4850 # Only ROUND_ROBIN and RING_HASH are supported
4851 # when the backend service is referenced by a URL map that is bound to
4852 # target gRPC proxy that has validateForProxyless field set to true.
4853 #
4854 # localityLbPolicy cannot be specified with haPolicy.
4855 &quot;logConfig&quot;: { # The available logging options for the load balancer traffic served by this # This field denotes the logging options for the load balancer traffic served
4856 # by this backend service. If logging is enabled, logs will be exported to
4857 # Stackdriver.
4858 # backend service.
4859 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
4860 # traffic served by this backend service. The default value is false.
4861 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
4862 { # Determines which HTTP headers will be logged to Stackdriver.
4863 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
4864 },
4865 ],
4866 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
4867 { # Determines which HTTP headers will be logged to Stackdriver.
4868 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
4869 },
4870 ],
4871 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
4872 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
4873 # of optional fields you want to include in the logs. For example:
4874 # serverInstance, serverGkeDetails.cluster,
4875 # serverGkeDetails.pod.podNamespace
4876 &quot;A String&quot;,
4877 ],
4878 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
4879 # service. Configures whether all, none or a subset of optional fields
4880 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
4881 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
4882 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
4883 # service. The value of the field must be in [0, 1]. This configures the
4884 # sampling rate of requests to the load balancer where 1.0 means all logged
4885 # requests are reported and 0.0 means no logged requests are reported. The
4886 # default value is 1.0.
4887 },
4888 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
4889 # service. Duration is computed from the beginning of the stream until the
4890 # response has been completely processed, including all retries. A stream
4891 # that does not complete in this duration is closed.
4892 #
4893 # If not specified, there will be no timeout limit, i.e. the maximum
4894 # duration is infinite.
4895 #
4896 # This value can be overridden in the PathMatcher configuration of the
4897 # UrlMap that references this backend service.
4898 #
4899 # This field is only allowed when the loadBalancingScheme of
4900 # the backend service is INTERNAL_SELF_MANAGED.
4901 # as a count of seconds and fractions of seconds at nanosecond
4902 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4903 # or &quot;month&quot;. Range is approximately 10,000 years.
4904 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4905 # Durations less than one second are represented with a 0
4906 # `seconds` field and a positive `nanos` field. Must be from 0
4907 # to 999,999,999 inclusive.
4908 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4909 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4910 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4911 },
4912 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
4913 # controller and read by the backend RCTH
4914 &quot;a_key&quot;: &quot;A String&quot;,
4915 },
4916 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4917 # The name must be 1-63 characters long, and comply withRFC1035.
4918 # Specifically, the name must be 1-63 characters long and match the regular
4919 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4920 # character must be a lowercase letter, and all following characters must
4921 # be a dash, lowercase letter, or digit, except the last character, which
4922 # cannot be a dash.
4923 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
4924 #
4925 # This field must be set for Internal Passthrough Network Load Balancers when
4926 # the haPolicy is enabled, and for External Passthrough Network Load
4927 # Balancers when the haPolicy fastIpMove is enabled.
4928 #
4929 # This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
4930 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
4931 # Load Balancers.
4932 #
4933 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
4934 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
4935 # endpoints in the local zone.
4936 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
4937 # possible values are:
4938 #
4939 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
4940 # is disabled. The load balancer distributes new connections to all
4941 # healthy backend endpoints across all zones.
4942 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
4943 # enabled. The load balancer distributes new connections to all healthy
4944 # backend endpoints in the local zone only. If there are no healthy
4945 # backend endpoints in the local zone, the load balancer distributes
4946 # new connections to all backend endpoints in the local zone.
4947 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
4948 # enabled. The load balancer distributes new connections to all healthy
4949 # backend endpoints in the local zone only. If there aren&#x27;t enough
4950 # healthy backend endpoints in the local zone, the load balancer
4951 # distributes new connections to all healthy backend endpoints across all
4952 # zones.
4953 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
4954 # of healthy backend endpoints in a zone to the count of backend
4955 # endpoints in that same zone is equal to or above this threshold, the
4956 # load balancer distributes new connections to all healthy endpoints in
4957 # the local zone only. When the ratio of the count of healthy backend
4958 # endpoints in a zone to the count of backend endpoints in that same
4959 # zone is below this threshold, the load balancer distributes all new
4960 # connections to all healthy endpoints across all zones.
4961 },
4962 },
4963 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
4964 # the backend service.
4965 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
4966 # service.
4967 },
4968 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
4969 # load balancing pool of each individual proxy instance that processes the
4970 # traffic for the given backend service. If not set, this feature is
4971 # considered disabled.
4972 #
4973 # Results of the outlier detection algorithm (ejection of endpoints from the
4974 # load balancing pool and returning them back to the pool) are executed
4975 # independently by each proxy instance of the load balancer. In most cases,
4976 # more than one proxy instance handles the traffic received by a backend
4977 # service. Thus, it is possible that an unhealthy endpoint is detected and
4978 # ejected by only some of the proxies, and while this happens, other proxies
4979 # may continue to send requests to the same unhealthy endpoint until they
4980 # detect and eject the unhealthy endpoint.
4981 #
4982 # Applicable backend endpoints can be:
4983 #
4984 # - VM instances in an Instance Group
4985 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
4986 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
4987 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
4988 # Functions Services
4989 # - Private Service Connect NEGs, that resolve to
4990 # Google-managed regional API endpoints or managed services published using
4991 # Private Service Connect
4992 #
4993 #
4994 #
4995 # Applicable backend service types can be:
4996 #
4997 # - A global backend service with the loadBalancingScheme set to
4998 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
4999 # - A regional backend
5000 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
5001 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
5002 # supported for Serverless NEGs.
5003 #
5004 #
5005 #
5006 # Not supported when the backend service is referenced by a URL map that is
5007 # bound to target gRPC proxy that has validateForProxyless field set to true.
5008 # pool for the backend service.
5009 &quot;baseEjectionTime&quot;: { # A Duration represents a fixed-length span of time represented # The base time that a backend endpoint is ejected for. Defaults to 30000ms
5010 # or 30s.
5011 #
5012 # After a backend endpoint is returned back to the load balancing pool, it
5013 # can be ejected again in another ejection analysis. Thus, the total ejection
5014 # time is equal to the base ejection time multiplied by the number of times
5015 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
5016 # as a count of seconds and fractions of seconds at nanosecond
5017 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5018 # or &quot;month&quot;. Range is approximately 10,000 years.
5019 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5020 # Durations less than one second are represented with a 0
5021 # `seconds` field and a positive `nanos` field. Must be from 0
5022 # to 999,999,999 inclusive.
5023 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5024 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5025 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5026 },
5027 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
5028 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
5029 # return code qualifies as an error. Defaults to 5.
5030 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
5031 # connection errors that are mapped to one of those status codes) before a
5032 # consecutive gateway failure ejection occurs. Defaults to 3.
5033 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5034 # outlier status is detected through consecutive 5xx. This setting can be
5035 # used to disable ejection or to ramp it up slowly. Defaults to 0.
5036 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5037 # outlier status is detected through consecutive gateway failures. This
5038 # setting can be used to disable ejection or to ramp it up slowly. Defaults
5039 # to 100.
5040 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5041 # outlier status is detected through success rate statistics. This setting
5042 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
5043 #
5044 # Not supported when the backend service uses Serverless NEG.
5045 &quot;interval&quot;: { # A Duration represents a fixed-length span of time represented # Time interval between ejection analysis sweeps. This can result in both new
5046 # ejections and backend endpoints being returned to service. The interval is
5047 # equal to the number of seconds as defined in
5048 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
5049 # in outlierDetection.interval.nanos. Defaults to 1 second.
5050 # as a count of seconds and fractions of seconds at nanosecond
5051 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5052 # or &quot;month&quot;. Range is approximately 10,000 years.
5053 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5054 # Durations less than one second are represented with a 0
5055 # `seconds` field and a positive `nanos` field. Must be from 0
5056 # to 999,999,999 inclusive.
5057 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5058 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5059 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5060 },
5061 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
5062 # backend service that can be ejected if the ejection conditions are met.
5063 # Defaults to 50%.
5064 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
5065 # enough request volume to detect success rate outliers. If the number of
5066 # backend endpoints is fewer than this setting, outlier detection via success
5067 # rate statistics is not performed for any backend endpoint in the load
5068 # balancing pool. Defaults to 5.
5069 #
5070 # Not supported when the backend service uses Serverless NEG.
5071 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
5072 # (as defined by the interval duration above) to include this backend
5073 # endpoint in success rate based outlier detection. If the volume is lower
5074 # than this setting, outlier detection via success rate statistics is not
5075 # performed for that backend endpoint. Defaults to 100.
5076 #
5077 # Not supported when the backend service uses Serverless NEG.
5078 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
5079 # outlier ejection. The ejection threshold is the difference between the mean
5080 # success rate, and the product of this factor and the standard deviation of
5081 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
5082 # is divided by a thousand to get a double. That is, if the desired factor
5083 # is 1.9, the runtime value should be 1900. Defaults to 1900.
5084 #
5085 # Not supported when the backend service uses Serverless NEG.
5086 },
5087 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
5088 # as part of resource payload.
5089 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
5090 # Tag keys and values have the same definition as resource
5091 # manager tags. The field is allowed for INSERT
5092 # only. The keys/values to set on the resource should be specified in
5093 # either ID { : } or Namespaced format
5094 # { : }.
5095 # For example the following are valid inputs:
5096 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
5097 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
5098 # Note:
5099 # * Invalid combinations of ID &amp; namespaced format is not supported. For
5100 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
5101 &quot;a_key&quot;: &quot;A String&quot;,
5102 },
5103 },
5104 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
5105 # the backend. The default value is 80.
5106 # For internal passthrough Network Load Balancers and external passthrough
5107 # Network Load Balancers, omit port.
5108 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
5109 # communication to the backend VMs in that group. The
5110 # named port must be [defined on each backend instance
5111 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
5112 # This parameter has no meaning if the backends are NEGs. For internal
5113 # passthrough Network Load Balancers and external passthrough Network Load
5114 # Balancers, omit port_name.
5115 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
5116 # with backends.
5117 #
5118 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
5119 # depending on the chosen load balancer or Traffic Director configuration.
5120 # Refer to the documentation for the load balancers or for Traffic Director
5121 # for more information.
5122 #
5123 # Must be set to GRPC when the backend service is referenced by a URL map
5124 # that is bound to target gRPC proxy.
5125 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
5126 # resides. This field is not applicable to global backend services.
5127 # You must specify this field as part of the HTTP request URL. It is
5128 # not settable as a field in the request body.
5129 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
5130 # backend service.
5131 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
5132 # service. This field is applicable to a global backend service with the
5133 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5134 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
5135 &quot;awsV4Authentication&quot;: { # Contains the configurations necessary to generate a signature for access to # The configuration needed to generate a signature for access to private
5136 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
5137 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
5138 # private storage buckets that support Signature Version 4 for authentication.
5139 # The service name for generating the authentication header will always default
5140 # to &#x27;s3&#x27;.
5141 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
5142 # creating a backend that uses AWS v4 signature authentication, but will not
5143 # be returned as part of the configuration when queried with a REST API GET
5144 # request.
5145 #
5146 # @InputOnly
5147 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
5148 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
5149 # keep track of different iterations of your access key.
5150 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
5151 # the name of the region your cloud uses to host your origin. For example,
5152 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
5153 },
5154 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
5155 # that describes how clients should authenticate with this service&#x27;s
5156 # backends.
5157 #
5158 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
5159 # to INTERNAL_SELF_MANAGED.
5160 #
5161 # If left blank, communications are not encrypted.
5162 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
5163 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
5164 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
5165 # specified values, the communication continues. Otherwise, it fails. This
5166 # additional check enables the client to verify that the server is authorized
5167 # to run the requested service.
5168 #
5169 # Note that the contents of the server
5170 # certificate&#x27;s subjectAltName field are configured by the
5171 # Public Key Infrastructure which provisions server identities.
5172 #
5173 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
5174 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
5175 # mode).
5176 &quot;A String&quot;,
5177 ],
5178 },
5179 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5180 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
5181 #
5182 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
5183 # If set, lists of backends and health checks must be both empty.
5184 &quot;A String&quot;,
5185 ],
5186 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
5187 #
5188 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
5189 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
5190 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
5191 #
5192 # Only NONE and HEADER_FIELD are supported
5193 # when the backend service is referenced by a URL map that is bound to
5194 # target gRPC proxy that has validateForProxyless field set to true.
5195 #
5196 # For more details, see:
5197 # [Session
5198 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
5199 #
5200 # sessionAffinity cannot be specified with haPolicy.
5201 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
5202 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
5203 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
5204 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
5205 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
5206 # as a count of seconds and fractions of seconds at nanosecond
5207 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5208 # or &quot;month&quot;. Range is approximately 10,000 years.
5209 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5210 # Durations less than one second are represented with a 0
5211 # `seconds` field and a positive `nanos` field. Must be from 0
5212 # to 999,999,999 inclusive.
5213 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5214 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5215 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5216 },
5217 },
5218 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
5219 # Currently this is applicable only for Internal TCP/UDP load balancing,
5220 # Internal HTTP(S) load balancing and Traffic Director.
5221 &quot;policy&quot;: &quot;A String&quot;,
5222 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
5223 # each service mesh client.
5224 #
5225 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
5226 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
5227 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
5228 # `INTERNAL_SELF_MANAGED`.
5229 #
5230 # `subset_size` is optional for Internal HTTP(S) load balancing
5231 # and required for Traffic Director.
5232 #
5233 # If you do not provide this value, Cloud Load Balancing will calculate it
5234 # dynamically to optimize the number of proxies/clients visible to each
5235 # backend and vice versa.
5236 #
5237 # Must be greater than 0. If `subset_size` is larger than the number of
5238 # backends/endpoints, then subsetting is disabled.
5239 },
5240 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
5241 # type of load balancer. For more information see,
5242 # Backend service settings.
5243 # The default is 30 seconds.
5244 # The full range of timeout values allowed goes from 1
5245 # through 2,147,483,647 seconds.
5246 #
5247 # This value can be overridden in the PathMatcher configuration of the
5248 # UrlMap that references this backend service.
5249 #
5250 # Not supported when the backend service is referenced by a URL map that is
5251 # bound to target gRPC proxy that has validateForProxyless field set to true.
5252 # Instead, use maxStreamDuration.
5253 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
5254 # when the backend protocol is SSL, HTTPS or HTTP2.
5255 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
5256 # networksecurity.googleapis.com namespace. Can be used in authenticating
5257 # TLS connections to the backend, as specified by the authenticationMode
5258 # field. Can only be specified if authenticationMode is not NONE.
5259 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
5260 #
5261 #
5262 # Use this property to configure the load balancer back-end to use
5263 # certificates and roots of trust provisioned by the Managed Workload
5264 # Identity system.
5265 #
5266 # The `identity` property is the
5267 # fully-specified SPIFFE ID to use in the SVID presented by the Load
5268 # Balancer Workload.
5269 #
5270 # The SPIFFE ID must be a resource starting with the
5271 # `trustDomain` property value, followed by the path to the Managed
5272 # Workload Identity.
5273 #
5274 # Supported SPIFFE ID format:
5275 #
5276 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
5277 #
5278 #
5279 # The Trust Domain within the Managed Identity must refer to a valid
5280 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
5281 # will be inherited from the Workload Identity Pool.
5282 #
5283 # Restrictions:
5284 #
5285 # - If you set the `identity` property, you cannot manually set
5286 # the following fields:
5287 # - tlsSettings.sni
5288 # - tlsSettings.subjectAltNames
5289 # - tlsSettings.authenticationConfig
5290 #
5291 #
5292 # When defining a `identity` for a RegionBackendServices, the
5293 # corresponding Workload Identity Pool must have a ca_pool
5294 # configured in the same region.
5295 #
5296 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
5297 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
5298 # balancer sends this string as the SNI hostname in the TLS connection to
5299 # the backend, and requires that this string match a Subject Alternative
5300 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
5301 # NEG backend, if the SNI is specified here, the load balancer uses it
5302 # regardless of whether the Regional Internet NEG is specified with FQDN or
5303 # IP address and port. When both sni and subjectAltNames[] are specified,
5304 # the load balancer matches the backend certificate&#x27;s SAN only to
5305 # subjectAltNames[].
5306 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
5307 # verifies during a TLS handshake with the backend. When the server
5308 # presents its X.509 certificate to the Load Balancer, the Load Balancer
5309 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
5310 # match one of the subjectAltNames in the list. This field is limited to 5
5311 # entries. When both sni and subjectAltNames[] are specified, the load
5312 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
5313 { # A Subject Alternative Name that the load balancer matches against the SAN
5314 # field in the TLS certificate provided by the backend, specified as either
5315 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
5316 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
5317 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
5318 },
5319 ],
5320 },
5321 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
5322 {
5323 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
5324 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
5325 # and ForwardingRule.
5326 },
5327 ],
5328 },
5329 ],
5330 &quot;kind&quot;: &quot;compute#backendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.
5331 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5332 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5333 # the query parameter pageToken in the next list request.
5334 # Subsequent list requests will have their own nextPageToken to
5335 # continue paging through the results.
5336 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5337 &quot;warning&quot;: { # [Output Only] Informational warning message.
5338 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5339 # Engine returns NO_RESULTS_ON_PAGE if there
5340 # are no results in the response.
5341 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5342 # value format. For example:
5343 #
5344 # &quot;data&quot;: [
5345 # {
5346 # &quot;key&quot;: &quot;scope&quot;,
5347 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5348 # }
5349 {
5350 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5351 # returned. For example, for warnings where there are no results in a list
5352 # request for a particular zone, this key might be scope and
5353 # the key value might be the zone name. Other examples might be a key
5354 # indicating a deprecated resource and a suggested replacement, or a
5355 # warning about invalid network settings (for example, if an instance
5356 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5357 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5358 },
5359 ],
5360 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5361 },
5362 }</pre>
5363 </div>
5364
5365 <div class="method">
5366 <code class="details" id="listUsable">listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5367 <pre>Retrieves a list of all usable backend services in the specified project in
5368 the given region.
5369
5370 Args:
5371 project: string, Project ID for this request. (required)
5372 region: string, Name of the region scoping this request.
5373 It must be a string that meets the requirements in RFC1035. (required)
5374 filter: string, A filter expression that filters resources listed in the response. Most
5375 Compute resources support two types of filter expressions:
5376 expressions that support regular expressions and expressions that follow
5377 API improvement proposal AIP-160.
5378 These two types of filter expressions cannot be mixed in one request.
5379
5380 If you want to use AIP-160, your expression must specify the field name, an
5381 operator, and the value that you want to use for filtering. The value
5382 must be a string, a number, or a boolean. The operator
5383 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5384
5385 For example, if you are filtering Compute Engine instances, you can
5386 exclude instances named `example-instance` by specifying
5387 `name != example-instance`.
5388
5389 The `:*` comparison can be used to test whether a key has been defined.
5390 For example, to find all objects with `owner` label use:
5391 ```
5392 labels.owner:*
5393 ```
5394
5395 You can also filter nested fields. For example, you could specify
5396 `scheduling.automaticRestart = false` to include instances only
5397 if they are not scheduled for automatic restarts. You can use filtering
5398 on nested fields to filter based onresource labels.
5399
5400 To filter on multiple expressions, provide each separate expression within
5401 parentheses. For example:
5402 ```
5403 (scheduling.automaticRestart = true)
5404 (cpuPlatform = &quot;Intel Skylake&quot;)
5405 ```
5406 By default, each expression is an `AND` expression. However, you
5407 can include `AND` and `OR` expressions explicitly.
5408 For example:
5409 ```
5410 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5411 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5412 (scheduling.automaticRestart = true)
5413 ```
5414
5415 If you want to use a regular expression, use the `eq` (equal) or `ne`
5416 (not equal) operator against a single un-parenthesized expression with or
5417 without quotes or against multiple parenthesized expressions. Examples:
5418
5419 `fieldname eq unquoted literal`
5420 `fieldname eq &#x27;single quoted literal&#x27;`
5421 `fieldname eq &quot;double quoted literal&quot;`
5422 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5423
5424 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5425 The literal value must match the entire field.
5426
5427 For example, to filter for instances that do not end with name &quot;instance&quot;,
5428 you would use `name ne .*instance`.
5429
5430 You cannot combine constraints on multiple fields using regular
5431 expressions.
5432 maxResults: integer, The maximum number of results per page that should be returned.
5433 If the number of available results is larger than `maxResults`,
5434 Compute Engine returns a `nextPageToken` that can be used to get
5435 the next page of results in subsequent list requests. Acceptable values are
5436 `0` to `500`, inclusive. (Default: `500`)
5437 orderBy: string, Sorts list results by a certain order. By default, results
5438 are returned in alphanumerical order based on the resource name.
5439
5440 You can also sort results in descending order based on the creation
5441 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5442 results based on the `creationTimestamp` field in
5443 reverse chronological order (newest result first). Use this to sort
5444 resources like operations so that the newest operation is returned first.
5445
5446 Currently, only sorting by `name` or
5447 `creationTimestamp desc` is supported.
5448 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5449 `nextPageToken` returned by a previous list request to get
5450 the next page of results.
5451 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5452 of failure. The default value is false.
5453
5454 For example, when partial success behavior is enabled, aggregatedList for a
5455 single zone scope either returns all resources in the zone or no resources,
5456 with an error code.
5457 x__xgafv: string, V1 error format.
5458 Allowed values
5459 1 - v1 error format
5460 2 - v2 error format
5461
5462 Returns:
5463 An object of the form:
5464
5465 { # Contains a list of usable BackendService resources.
5466 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
5467 &quot;items&quot;: [ # A list of BackendService resources.
5468 { # Represents a Backend Service resource.
5469 #
5470 # A backend service defines how Google Cloud load balancers distribute traffic.
5471 # The backend service configuration contains a set of values, such as the
5472 # protocol used to connect to backends, various distribution and session
5473 # settings, health checks, and timeouts. These settings provide fine-grained
5474 # control over how your load balancer behaves. Most of the settings have
5475 # default values that allow for easy configuration if you need to get started
5476 # quickly.
5477 #
5478 # Backend services in Google Compute Engine can be either regionally or
5479 # globally scoped.
5480 #
5481 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
5482 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
5483 #
5484 # For more information, seeBackend
5485 # Services.
5486 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
5487 # Load Balancers and Traffic Director and requires
5488 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
5489 #
5490 # If set to 0, the cookie is non-persistent and lasts only until
5491 # the end of the browser session (or equivalent). The maximum allowed value
5492 # is two weeks (1,209,600).
5493 #
5494 # Not supported when the backend service is referenced by a URL map that is
5495 # bound to target gRPC proxy that has validateForProxyless field set to true.
5496 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
5497 { # Message containing information of one individual backend.
5498 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
5499 # handle additional traffic or is fully loaded. For usage guidelines, see
5500 # Connection balancing mode.
5501 #
5502 # Backends must use compatible balancing modes. For more information, see
5503 # Supported balancing modes and target capacity settings and
5504 # Restrictions and guidance for instance groups.
5505 #
5506 # Note: Currently, if you use the API to configure incompatible balancing
5507 # modes, the configuration might be accepted even though it has no impact
5508 # and is ignored. Specifically, Backend.maxUtilization is ignored when
5509 # Backend.balancingMode is RATE. In the future, this incompatible combination
5510 # will be rejected.
5511 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
5512 # mode.
5513 # The default value is 1, which means the group serves up to
5514 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
5515 # completely drained, offering 0% of its available capacity. The valid ranges
5516 # are 0.0 and [0.1,1.0].
5517 # You cannot configure a setting larger than 0 and smaller than0.1.
5518 # You cannot configure a setting of 0 when there is only one
5519 # backend attached to the backend service.
5520 #
5521 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
5522 # internet NEGs, regional serverless NEGs, and PSC NEGs.
5523 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
5524 # BalancingMode.
5525 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
5526 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
5527 # Monitoring, but is not used for load balancing.
5528 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
5529 # balancing mode. The valid range is [0.0, 1.0].
5530 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5531 # long and match the regular expression
5532 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5533 # first character must be a lowercase letter, and all following
5534 # characters must be a dash, period, underscore, lowercase letter, or
5535 # digit, except the last character, which cannot be a dash, period, or
5536 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5537 # field can only be used for a global or regional backend service with the
5538 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5539 },
5540 ],
5541 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5542 # create the resource.
5543 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
5544 # failover backend can be configured for a given BackendService.
5545 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
5546 # group or network endpoint
5547 # group (NEG) resource. To determine what types of backends a load
5548 # balancer supports, see the [Backend services
5549 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
5550 #
5551 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
5552 # or NEG. Partial URLs are not supported.
5553 #
5554 # If haPolicy is specified, backends must refer to NEG resources of type
5555 # GCE_VM_IP.
5556 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5557 # guidelines, seeConnection
5558 # balancing mode and Utilization
5559 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
5560 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5561 # guidelines, seeConnection
5562 # balancing mode and Utilization
5563 # balancing mode.
5564 #
5565 # Not available if the backend&#x27;s balancingMode isRATE.
5566 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
5567 # For usage guidelines, seeConnection
5568 # balancing mode and Utilization
5569 # balancing mode.
5570 #
5571 # Not available if the backend&#x27;s balancingMode isRATE.
5572 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
5573 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
5574 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
5575 # Not available if backend&#x27;s balancingMode is RATE
5576 # or CONNECTION.
5577 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
5578 # Not available if backend&#x27;s balancingMode is RATE
5579 # or CONNECTION.
5580 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
5581 # usage guidelines, seeRate
5582 # balancing mode and Utilization
5583 # balancing mode.
5584 #
5585 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5586 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
5587 # guidelines, seeRate
5588 # balancing mode and Utilization
5589 # balancing mode.
5590 #
5591 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5592 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
5593 # guidelines, seeRate
5594 # balancing mode and Utilization
5595 # balancing mode.
5596 #
5597 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5598 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
5599 #
5600 # For usage guidelines, seeUtilization
5601 # balancing mode.
5602 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
5603 # the backend.
5604 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
5605 },
5606 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
5607 # sending traffic to backends with default preference. The possible values
5608 # are:
5609 #
5610 # - PREFERRED: Backends with this preference level will be
5611 # filled up to their capacity limits first, based on RTT.
5612 # - DEFAULT: If preferred backends don&#x27;t have enough
5613 # capacity, backends in this layer would be used and traffic would be
5614 # assigned based on the load balancing algorithm you use. This is the
5615 # default
5616 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
5617 # Attachment).
5618 # e.g.
5619 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
5620 # for Cloud Run service.
5621 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
5622 # for PSC Service Attachment.
5623 &quot;trafficDuration&quot;: &quot;A String&quot;,
5624 },
5625 ],
5626 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
5627 # specified load balancer types.
5628 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
5629 # Pragma or Authorization headers. Up to 5 headers can be specified.
5630 # The cache is bypassed for all cdnPolicy.cacheMode settings.
5631 { # Bypass the cache when the specified request headers are present,
5632 # e.g. Pragma or Authorization headers. Values are case insensitive.
5633 # The presence of such a header overrides the cache_mode setting.
5634 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
5635 # Values are case-insensitive.
5636 },
5637 ],
5638 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
5639 # CDN.
5640 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
5641 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
5642 &quot;A String&quot;,
5643 ],
5644 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
5645 # The name=value pair will be used in the cache key Cloud CDN generates.
5646 &quot;A String&quot;,
5647 ],
5648 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
5649 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
5650 # query_string_whitelist and query_string_blacklist. If neither is set, the
5651 # entire query string will be included. If false, the query string will be
5652 # excluded from the cache key entirely.
5653 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
5654 # parameters will be included. Either specify query_string_whitelist or
5655 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
5656 # not treated as delimiters.
5657 &quot;A String&quot;,
5658 ],
5659 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
5660 # parameters will be excluded. Either specify query_string_whitelist or
5661 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
5662 # not treated as delimiters.
5663 &quot;A String&quot;,
5664 ],
5665 },
5666 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
5667 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
5668 # headers to cache content. Responses without these headers will not be
5669 # cached at Google&#x27;s edge, and will require a full trip to the origin on
5670 # every request, potentially impacting performance and increasing load on
5671 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
5672 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
5673 # Warning: this may result in Cloud CDN caching private,
5674 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
5675 # including common image formats, media (video and audio), and web assets
5676 # (JavaScript and CSS). Requests and responses that are marked as
5677 # uncacheable, as well as dynamic content (including HTML), will not be
5678 # cached.
5679 #
5680 # If no value is provided for cdnPolicy.cacheMode, it defaults
5681 # to CACHE_ALL_STATIC.
5682 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
5683 # used to clamp the max-age (or Expires) value sent to the client. With
5684 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
5685 # response max-age directive, along with a &quot;public&quot; directive. For
5686 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
5687 # from the origin (if specified), or else sets the response max-age
5688 # directive to the lesser of the client_ttl and default_ttl, and also
5689 # ensures a &quot;public&quot; cache-control directive is present.
5690 # If a client TTL is not specified, a default value (1 hour) will be used.
5691 # The maximum allowed value is 31,622,400s (1 year).
5692 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
5693 # responses that do not have an existing valid TTL (max-age or s-maxage).
5694 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5695 # The value of defaultTTL cannot be set to a value greater than that of
5696 # maxTTL, but can be equal.
5697 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
5698 # will overwrite the TTL set in all responses. The maximum allowed value is
5699 # 31,622,400s (1 year), noting that infrequently accessed objects may be
5700 # evicted from the cache before the defined TTL.
5701 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
5702 # origin.
5703 # Cache directives that attempt to set a max-age or s-maxage higher than
5704 # this, or an Expires header more than maxTTL seconds in the future will
5705 # be capped at the value of maxTTL, as if it were the value of an
5706 # s-maxage Cache-Control directive.
5707 # Headers sent to the client will not be modified.
5708 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5709 # The maximum allowed value is 31,622,400s (1 year), noting that
5710 # infrequently accessed objects may be evicted from the cache before
5711 # the defined TTL.
5712 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
5713 # to apply fine-grained caching for common errors or redirects.
5714 # This can reduce the load on your origin and improve end-user
5715 # experience by reducing response latency.
5716 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
5717 # negative caching applies to responses with the specified response code
5718 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
5719 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
5720 # to all responses with the specified response code, and override any
5721 # caching headers.
5722 # By default, Cloud CDN will apply the following default TTLs to these
5723 # status codes:
5724 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
5725 # HTTP 404 (Not Found), 410 (Gone),
5726 # 451 (Unavailable For Legal Reasons): 120s
5727 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
5728 # These defaults can be overridden in negative_caching_policy.
5729 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
5730 # negative_caching must be enabled to configure negative_caching_policy.
5731 # Omitting the policy and leaving negative_caching enabled will use
5732 # Cloud CDN&#x27;s default cache TTLs.
5733 # Note that when specifying an explicit negative_caching_policy, you
5734 # should take care to specify a cache TTL for all response codes
5735 # that you wish to cache. Cloud CDN will not apply any default
5736 # negative caching when a policy exists.
5737 { # Specify CDN TTLs for response error codes.
5738 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
5739 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
5740 # specified as values, and you cannot specify a status code more than
5741 # once.
5742 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
5743 # corresponding status code.
5744 # The maximum allowed value is 1800s (30 minutes), noting that
5745 # infrequently accessed objects may be evicted from the cache before the
5746 # defined TTL.
5747 },
5748 ],
5749 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
5750 # requests into a small number of requests to the origin.
5751 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
5752 # content with the origin, or when an error is encountered when refreshing
5753 # the cache.
5754 # This setting defines the default &quot;max-stale&quot; duration for any cached
5755 # responses that do not specify a max-stale directive. Stale responses that
5756 # exceed the TTL configured here will not be served. The default limit
5757 # (max-stale) is 86400s (1 day), which will allow stale content to be
5758 # served up to this limit beyond the max-age (or s-maxage) of a cached
5759 # response.
5760 # The maximum allowed value is 604800 (1 week).
5761 # Set this to zero (0) to disable serve-while-stale.
5762 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
5763 # considered fresh. After this time period, the response will be
5764 # revalidated before being served. Defaults to 1hr (3600s). When serving
5765 # responses to signed URL requests, Cloud CDN will internally behave as
5766 # though all responses from this backend had a &quot;Cache-Control:
5767 # public, max-age=[TTL]&quot; header, regardless of any existing
5768 # Cache-Control header. The actual headers served in responses will not be
5769 # altered.
5770 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
5771 &quot;A String&quot;,
5772 ],
5773 },
5774 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
5775 # backend service.
5776 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
5777 # as a count of seconds and fractions of seconds at nanosecond
5778 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5779 # or &quot;month&quot;. Range is approximately 10,000 years.
5780 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5781 # Durations less than one second are represented with a 0
5782 # `seconds` field and a positive `nanos` field. Must be from 0
5783 # to 999,999,999 inclusive.
5784 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5785 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5786 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5787 },
5788 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
5789 # there is no limit.
5790 #
5791 # Not supported when the backend service is referenced by a URL map that is
5792 # bound to target gRPC proxy that has validateForProxyless field set to true.
5793 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
5794 # not specified, there is no limit.
5795 #
5796 # Not supported when the backend service is referenced by a URL map that is
5797 # bound to target gRPC proxy that has validateForProxyless field set to true.
5798 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
5799 # service. If not specified, there is no limit.
5800 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
5801 # This parameter is respected by both the HTTP/1.1 and HTTP/2
5802 # implementations. If not specified, there is no limit. Setting this
5803 # parameter to 1 will effectively disable keep alive.
5804 #
5805 # Not supported when the backend service is referenced by a URL map that is
5806 # bound to target gRPC proxy that has validateForProxyless field set to true.
5807 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
5808 # not specified, the default is 1.
5809 #
5810 # Not supported when the backend service is referenced by a URL map that is
5811 # bound to target gRPC proxy that has validateForProxyless field set to true.
5812 },
5813 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
5814 # the client&#x27;s Accept-Encoding header.
5815 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
5816 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
5817 # instance. For supported load balancers and protocols, as described inEnabling
5818 # connection draining.
5819 },
5820 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
5821 # tracking policy settings are only available for external passthrough
5822 # Network Load Balancers and internal passthrough Network Load Balancers.
5823 #
5824 # connectionTrackingPolicy cannot be specified with haPolicy.
5825 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
5826 # value is DEFAULT_FOR_PROTOCOL.
5827 #
5828 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
5829 # persist on unhealthy backends only for connection-oriented protocols
5830 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
5831 # Affinity is configured for 5-tuple. They do not persist forUDP.
5832 #
5833 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
5834 # the existing connections on the unhealthy backend are never persisted on
5835 # the unhealthy backend. They are always diverted to newly selected healthy
5836 # backends (unless all backends are unhealthy).
5837 #
5838 # If set to ALWAYS_PERSIST, existing connections always
5839 # persist on unhealthy backends regardless of protocol and session
5840 # affinity. It is generally not recommended to use this mode overriding the
5841 # default.
5842 #
5843 # For more details, see [Connection Persistence for Network Load
5844 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
5845 # and [Connection Persistence for Internal TCP/UDP Load
5846 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
5847 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
5848 # Balancers. This option is not available publicly.
5849 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
5850 # matching traffic (in seconds).
5851 #
5852 # For internal passthrough Network Load Balancers:
5853 #
5854 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
5855 # - It can be set only if Connection Tracking is less than 5-tuple
5856 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
5857 # Mode is PER_SESSION).
5858 #
5859 #
5860 #
5861 # For external passthrough Network Load Balancers the default is 60
5862 # seconds. This option is not available publicly.
5863 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
5864 # options:
5865 #
5866 # - PER_CONNECTION: This is the default mode. The Connection
5867 # Tracking is performed as per the Connection Key (default Hash Method) for
5868 # the specific protocol.
5869 # - PER_SESSION: The Connection Tracking is performed as per
5870 # the configured Session Affinity. It matches the configured Session
5871 # Affinity.
5872 #
5873 #
5874 #
5875 # For more details, see [Tracking Mode for Network Load
5876 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
5877 # and [Tracking Mode for Internal TCP/UDP Load
5878 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
5879 },
5880 &quot;consistentHash&quot;: { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session
5881 # affinity based on HTTP headers, cookies or other properties. This load
5882 # balancing policy is applicable only for HTTP connections. The affinity to a
5883 # particular destination host will be lost when one or more hosts are
5884 # added/removed from the destination service. This field specifies parameters
5885 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
5886 #
5887 # This field is applicable to either:
5888 #
5889 # - A regional backend service with the service protocol set to HTTP,
5890 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
5891 # INTERNAL_MANAGED.
5892 # - A global backend service with the
5893 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5894 &quot;httpCookie&quot;: { # The information about the HTTP Cookie on which the hash function is based # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
5895 # be used as the hash key for the consistent hash load balancer. If the
5896 # cookie is not present, it will be generated. This field is applicable if
5897 # the sessionAffinity is set to HTTP_COOKIE.
5898 #
5899 # Not supported when the backend service is referenced by a URL map that is
5900 # bound to target gRPC proxy that has validateForProxyless field set to true.
5901 # for load balancing policies that use a consistent hash.
5902 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
5903 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
5904 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
5905 # as a count of seconds and fractions of seconds at nanosecond
5906 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5907 # or &quot;month&quot;. Range is approximately 10,000 years.
5908 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5909 # Durations less than one second are represented with a 0
5910 # `seconds` field and a positive `nanos` field. Must be from 0
5911 # to 999,999,999 inclusive.
5912 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5913 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5914 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5915 },
5916 },
5917 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
5918 # applicable if the sessionAffinity is set toHEADER_FIELD.
5919 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
5920 # 1024. Larger ring sizes result in more granular load distributions. If the
5921 # number of hosts in the load balancing pool is larger than the ring size,
5922 # each host will be assigned a single virtual node.
5923 },
5924 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5925 # text format.
5926 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
5927 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
5928 # locality_lb_policy.
5929 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
5930 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5931 # long and match the regular expression
5932 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5933 # first character must be a lowercase letter, and all following
5934 # characters must be a dash, period, underscore, lowercase letter, or
5935 # digit, except the last character, which cannot be a dash, period, or
5936 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5937 # field can only be used for a global or regional backend service with the
5938 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5939 },
5940 ],
5941 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
5942 # custom
5943 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5944 &quot;A String&quot;,
5945 ],
5946 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
5947 # custom
5948 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5949 &quot;A String&quot;,
5950 ],
5951 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5952 # create the resource.
5953 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
5954 # backend service with dynamic forwarding feature which together with Service
5955 # Extension allows customized and complex routing logic.
5956 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
5957 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
5958 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
5959 },
5960 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
5961 # service. Some ranges are restricted: Restricted
5962 # ranges.
5963 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
5964 },
5965 },
5966 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
5967 # this backend service.
5968 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
5969 # global external Application Load Balancer.
5970 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
5971 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
5972 #
5973 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
5974 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
5975 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
5976 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
5977 # externalManagedMigrationTestingPercentage.
5978 #
5979 # Rolling back a migration requires the states to be set in reverse order. So
5980 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
5981 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
5982 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
5983 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
5984 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
5985 # external Application Load Balancer.
5986 #
5987 # The value of this field must be in the range [0, 100].
5988 #
5989 # Session affinity options will slightly affect this routing behavior, for
5990 # more details, see:Session
5991 # Affinity.
5992 #
5993 # This value can only be set if the loadBalancingScheme in the BackendService
5994 # is set to EXTERNAL (when using the classic Application Load Balancer) and
5995 # the migration state is TEST_BY_PERCENTAGE.
5996 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
5997 # as a backup (failover) backend.
5998 # For load balancers that have configurable failover:
5999 # [Internal passthrough Network Load
6000 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6001 # and [external passthrough Network Load
6002 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6003 #
6004 # failoverPolicy cannot be specified with haPolicy.
6005 # failover:
6006 # [Internal passthrough Network Load
6007 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6008 # and [external passthrough
6009 # Network Load
6010 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6011 # On failover or failback, this field indicates whether connection draining
6012 # will be honored. Google Cloud has a fixed connection draining timeout of
6013 # 10 minutes. A setting of true terminates existing TCP
6014 # connections to the active pool during failover and failback, immediately
6015 # draining traffic. A setting of false allows existing TCP
6016 # connections to persist, even on VMs no longer in the active pool, for up
6017 # to the duration of the connection draining timeout (10 minutes).
6018 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
6019 #
6020 # The default is false.
6021 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
6022 # load balancer are dropped when all primary and all backup backend VMs are
6023 # unhealthy.If set to false, connections are distributed
6024 # among all primary VMs when all primary and all backup backend VMs are
6025 # unhealthy.
6026 # For load balancers that have configurable
6027 # failover:
6028 # [Internal passthrough
6029 # Network Load
6030 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6031 # and [external passthrough
6032 # Network Load
6033 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6034 # The default is false.
6035 &quot;failoverRatio&quot;: 3.14, # The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
6036 # failover when the number of healthy primary VMs equals zero.
6037 # For all other values, the load balancer performs a failover when the
6038 # total number of healthy primary VMs is less than this ratio.
6039 # For load balancers that have configurable
6040 # failover:
6041 # [Internal TCP/UDP Load
6042 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6043 # and [external TCP/UDP Load
6044 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6045 },
6046 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
6047 # This field is used in optimistic locking. This field will be ignored when
6048 # inserting a BackendService. An up-to-date fingerprint must be provided in
6049 # order to update the BackendService, otherwise the request will
6050 # fail with error 412 conditionNotMet.
6051 #
6052 # To see the latest fingerprint, make a get() request to
6053 # retrieve a BackendService.
6054 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
6055 # Protocol Forwarding.
6056 #
6057 # The backends of this regional backend service must only specify zonal
6058 # network endpoint groups (NEGs) of type GCE_VM_IP.
6059 #
6060 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
6061 # regional backend service must set the network field. All zonal NEGs must
6062 # belong to the same network. However, individual NEGs can
6063 # belong to different subnetworks of that network.
6064 #
6065 # When haPolicy is specified, the set of attached network endpoints across
6066 # all backends comprise an High Availability domain from which one endpoint
6067 # is selected as the active endpoint (the leader) that receives all
6068 # traffic.
6069 #
6070 # haPolicy can be added only at backend service creation time. Once set up,
6071 # it cannot be deleted.
6072 #
6073 # Note that haPolicy is not for load balancing, and therefore cannot be
6074 # specified with sessionAffinity, connectionTrackingPolicy, and
6075 # failoverPolicy.
6076 #
6077 # haPolicy requires customers to be responsible for tracking backend
6078 # endpoint health and electing a leader among the healthy endpoints.
6079 # Therefore, haPolicy cannot be specified with healthChecks.
6080 #
6081 # haPolicy can only be specified for External Passthrough Network Load
6082 # Balancers and Internal Passthrough Network Load Balancers.
6083 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
6084 # achieve it.
6085 #
6086 # Supported values are:
6087 #
6088 # - DISABLED: Fast IP Move is disabled. You can only use the
6089 # haPolicy.leader API to update the leader.
6090 # - &gt;GARP_RA: Provides a method to very quickly define a new network
6091 # endpoint as the leader. This method is faster than updating the leader
6092 # using the haPolicy.leader API. Fast IP move works as follows: The VM
6093 # hosting the network endpoint that should become the new leader sends
6094 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
6095 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
6096 # temporarily associates the forwarding rule IP address with that VM, and
6097 # both new and in-flight packets are quickly delivered to that VM.
6098 #
6099 #
6100 #
6101 # Note the important properties of the Fast IP Move functionality:
6102 #
6103 # - The GARP/RA-initiated re-routing stays active for approximately 20
6104 # minutes. After triggering fast failover, you must also
6105 # appropriately set the haPolicy.leader.
6106 # - The new leader instance should continue to send GARP/RA packets
6107 # periodically every 10 seconds until at least 10 minutes after updating
6108 # the haPolicy.leader (but stop immediately if it is no longer the leader).
6109 # - After triggering a fast failover, we recommend that you wait at least
6110 # 3 seconds before sending another GARP/RA packet from a different VM
6111 # instance to avoid race conditions.
6112 # - Don&#x27;t send GARP/RA packets from different VM
6113 # instances at the same time. If multiple instances continue to send
6114 # GARP/RA packets, traffic might be routed to different destinations in an
6115 # alternating order. This condition ceases when a single instance
6116 # issues a GARP/RA packet.
6117 # - The GARP/RA request always takes priority over the leader API.
6118 # Using the haPolicy.leader API to change the leader to a different
6119 # instance will have no effect until the GARP/RA request becomes
6120 # inactive.
6121 # - The GARP/RA packets should follow the GARP/RA
6122 # Packet Specifications..
6123 # - When multiple forwarding rules refer to a regional backend service,
6124 # you need only send a GARP or RA packet for a single forwarding rule
6125 # virtual IP. The virtual IPs for all forwarding rules targeting the same
6126 # backend service will also be moved to the sender of the GARP or RA
6127 # packet.
6128 #
6129 #
6130 #
6131 # The following are the Fast IP Move limitations (that is, when fastIPMove
6132 # is not DISABLED):
6133 #
6134 # - Multiple forwarding rules cannot use the same IP address if one of
6135 # them refers to a regional backend service with fastIPMove.
6136 # - The regional backend service must set the network field, and all
6137 # NEGs must belong to that network. However, individual
6138 # NEGs can belong to different subnetworks of that network.
6139 # - The maximum number of network endpoints across all backends of a
6140 # backend service with fastIPMove is 32.
6141 # - The maximum number of backend services with fastIPMove that can have
6142 # the same network endpoint attached to one of its backends is 64.
6143 # - The maximum number of backend services with fastIPMove in a VPC in a
6144 # region is 64.
6145 # - The network endpoints that are attached to a backend of a backend
6146 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
6147 # - Traffic directed to the leader by a static route next hop will not be
6148 # redirected to a new leader by fast failover. Such traffic will only be
6149 # redirected once an haPolicy.leader update has taken effect. Only traffic
6150 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
6151 # fast failover.
6152 #
6153 #
6154 # haPolicy.fastIPMove can be set only at backend service creation time.
6155 # Once set, it cannot be updated.
6156 #
6157 # By default, fastIpMove is set to DISABLED.
6158 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
6159 # this service as the active endpoint (the leader) that receives all
6160 # traffic.
6161 #
6162 # When the leader changes, there is no connection draining to persist
6163 # existing connections on the old leader.
6164 #
6165 # You are responsible for selecting a suitable endpoint as the
6166 # leader. For example, preferring a healthy endpoint over unhealthy ones.
6167 # Note that this service does not track backend endpoint health, and
6168 # selects the configured leader unconditionally.
6169 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
6170 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
6171 # that the leader is attached to.
6172 #
6173 # The leader&#x27;s backendGroup must already be specified as a backend of
6174 # this backend service. Removing a backend that is designated as the
6175 # leader&#x27;s backendGroup is not permitted.
6176 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
6177 # designated as the leader.
6178 #
6179 # This network endpoint cannot be detached from the NEG specified in
6180 # the haPolicy.leader.backendGroup until the leader is updated with
6181 # another network endpoint, or the leader is removed from the haPolicy.
6182 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
6183 # instance must already be attached to the NEG specified in the
6184 # haPolicy.leader.backendGroup.
6185 #
6186 # The name must be 1-63 characters long, and comply with RFC1035.
6187 # Authorization requires the following IAM permission on the
6188 # specified resource instance: compute.instances.use
6189 },
6190 },
6191 },
6192 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
6193 # httpsHealthChecks (legacy) resource for health checking this backend
6194 # service. Not all backend services support legacy health checks. See
6195 # Load balancer guide. Currently, at most one health check can be
6196 # specified for each backend service. Backend services with
6197 # instance group or zonal NEG backends must have a health check unless
6198 # haPolicy is specified. Backend services with internet or serverless NEG
6199 # backends must not have a health check.
6200 #
6201 # healthChecks[] cannot be specified with haPolicy.
6202 &quot;A String&quot;,
6203 ],
6204 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
6205 # Not available for internal passthrough Network Load Balancers and external
6206 # passthrough Network Load Balancers.
6207 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
6208 # incoming requests.
6209 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
6210 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
6211 # For security reasons, this value cannot be retrieved via the API.
6212 # Instead, the SHA-256 hash of the value is returned in the
6213 # oauth2ClientSecretSha256 field.
6214 #
6215 # @InputOnly
6216 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
6217 },
6218 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
6219 # defined by the server.
6220 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
6221 # from the client to the backend for proxyless gRPC).
6222 # The possible values are:
6223 #
6224 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
6225 # backend service (Instance Group, Managed Instance Group, Network Endpoint
6226 # Group), regardless of traffic from the client to the proxy. Only IPv4
6227 # health checks are used to check the health of the backends. This is the
6228 # default setting.
6229 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
6230 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
6231 # address).
6232 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
6233 # backend service (Instance Group, Managed Instance Group, Network Endpoint
6234 # Group), regardless of traffic from the client to the proxy. Only IPv6
6235 # health checks are used to check the health of the backends.
6236 #
6237 #
6238 #
6239 # This field is applicable to either:
6240 #
6241 # - Advanced global external Application Load Balancer (load balancing
6242 # scheme EXTERNAL_MANAGED),
6243 # - Regional external Application Load
6244 # Balancer,
6245 # - Internal proxy Network Load Balancer (load balancing
6246 # scheme INTERNAL_MANAGED),
6247 # - Regional internal Application Load
6248 # Balancer (load balancing scheme INTERNAL_MANAGED),
6249 # - Traffic
6250 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
6251 # INTERNAL_SELF_MANAGED).
6252 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
6253 # for backend services.
6254 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
6255 # created for one type of load balancer cannot be used with another.
6256 # For more information, refer toChoosing
6257 # a load balancer.
6258 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
6259 # preference. When you use localityLbPolicies, you must set at least one
6260 # value for either the localityLbPolicies[].policy or the
6261 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
6262 # value set in the localityLbPolicy field.
6263 #
6264 # For an example of how to use this field, seeDefine
6265 # a list of preferred policies.
6266 #
6267 # Caution: This field and its children are intended for use in a service mesh
6268 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
6269 # that have this configuration.
6270 { # Container for either a built-in LB policy supported by gRPC or Envoy or
6271 # a custom one implemented by the end user.
6272 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
6273 # deployed with the client.
6274 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
6275 # by a locally installed custom policy implementation.
6276 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
6277 #
6278 # The value should match the name of a custom implementation registered
6279 # on the gRPC clients. It should follow protocol buffer message naming
6280 # conventions and include the full path (for example,
6281 # myorg.CustomLbPolicy). The maximum length is 256 characters.
6282 #
6283 # Do not specify the same custom policy more than once for a
6284 # backend. If you do, the configuration is rejected.
6285 #
6286 # For an example of how to use this field, seeUse
6287 # a custom policy.
6288 },
6289 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
6290 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
6291 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
6292 # about these values, see the description of localityLbPolicy.
6293 #
6294 # Do not specify the same policy more than once for a
6295 # backend. If you do, the configuration is rejected.
6296 },
6297 },
6298 ],
6299 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
6300 # possible values are:
6301 #
6302 # - ROUND_ROBIN: This is a simple policy in which each healthy
6303 # backend is selected in round robin order. This is the default.
6304 # - LEAST_REQUEST: An O(1) algorithm which
6305 # selects two random healthy hosts and picks the host which has fewer active
6306 # requests.
6307 # - RING_HASH: The ring/modulo hash load balancer implements
6308 # consistent hashing to backends. The algorithm has the property that the
6309 # addition/removal of a host from a set of N hosts only affects 1/N of the
6310 # requests.
6311 # - RANDOM: The load balancer selects a random healthy
6312 # host.
6313 # - ORIGINAL_DESTINATION: Backend host is selected
6314 # based on the client connection metadata, i.e., connections are opened to
6315 # the same address as the destination address of the incoming connection
6316 # before the connection was redirected to the load balancer.
6317 # - MAGLEV: used as a drop in replacement for the ring hash
6318 # load balancer. Maglev is not as stable as ring hash but has faster table
6319 # lookup build times and host selection times. For more information about
6320 # Maglev, see Maglev:
6321 # A Fast and Reliable Software Network Load Balancer.
6322 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
6323 # Load Balancing using weights computed from Backend reported Custom Metrics.
6324 # If set, the Backend Service responses are expected to contain non-standard
6325 # HTTP response header field Endpoint-Load-Metrics. The reported
6326 # metrics to use for computing the weights are specified via thecustomMetrics field.
6327 #
6328 # This field is applicable to either:
6329 # - A regional backend service with the service protocol set to HTTP,
6330 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6331 # INTERNAL_MANAGED.
6332 # - A global backend service with the
6333 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
6334 # EXTERNAL_MANAGED.
6335 #
6336 #
6337 # If sessionAffinity is not configured—that is, if session
6338 # affinity remains at the default value of NONE—then the
6339 # default value for localityLbPolicy
6340 # is ROUND_ROBIN. If session affinity is set to a value other
6341 # than NONE,
6342 # then the default value for localityLbPolicy isMAGLEV.
6343 #
6344 # Only ROUND_ROBIN and RING_HASH are supported
6345 # when the backend service is referenced by a URL map that is bound to
6346 # target gRPC proxy that has validateForProxyless field set to true.
6347 #
6348 # localityLbPolicy cannot be specified with haPolicy.
6349 &quot;logConfig&quot;: { # The available logging options for the load balancer traffic served by this # This field denotes the logging options for the load balancer traffic served
6350 # by this backend service. If logging is enabled, logs will be exported to
6351 # Stackdriver.
6352 # backend service.
6353 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
6354 # traffic served by this backend service. The default value is false.
6355 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
6356 { # Determines which HTTP headers will be logged to Stackdriver.
6357 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6358 },
6359 ],
6360 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
6361 { # Determines which HTTP headers will be logged to Stackdriver.
6362 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6363 },
6364 ],
6365 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
6366 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
6367 # of optional fields you want to include in the logs. For example:
6368 # serverInstance, serverGkeDetails.cluster,
6369 # serverGkeDetails.pod.podNamespace
6370 &quot;A String&quot;,
6371 ],
6372 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
6373 # service. Configures whether all, none or a subset of optional fields
6374 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
6375 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
6376 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
6377 # service. The value of the field must be in [0, 1]. This configures the
6378 # sampling rate of requests to the load balancer where 1.0 means all logged
6379 # requests are reported and 0.0 means no logged requests are reported. The
6380 # default value is 1.0.
6381 },
6382 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
6383 # service. Duration is computed from the beginning of the stream until the
6384 # response has been completely processed, including all retries. A stream
6385 # that does not complete in this duration is closed.
6386 #
6387 # If not specified, there will be no timeout limit, i.e. the maximum
6388 # duration is infinite.
6389 #
6390 # This value can be overridden in the PathMatcher configuration of the
6391 # UrlMap that references this backend service.
6392 #
6393 # This field is only allowed when the loadBalancingScheme of
6394 # the backend service is INTERNAL_SELF_MANAGED.
6395 # as a count of seconds and fractions of seconds at nanosecond
6396 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6397 # or &quot;month&quot;. Range is approximately 10,000 years.
6398 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6399 # Durations less than one second are represented with a 0
6400 # `seconds` field and a positive `nanos` field. Must be from 0
6401 # to 999,999,999 inclusive.
6402 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6403 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6404 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6405 },
6406 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
6407 # controller and read by the backend RCTH
6408 &quot;a_key&quot;: &quot;A String&quot;,
6409 },
6410 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6411 # The name must be 1-63 characters long, and comply withRFC1035.
6412 # Specifically, the name must be 1-63 characters long and match the regular
6413 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6414 # character must be a lowercase letter, and all following characters must
6415 # be a dash, lowercase letter, or digit, except the last character, which
6416 # cannot be a dash.
6417 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
6418 #
6419 # This field must be set for Internal Passthrough Network Load Balancers when
6420 # the haPolicy is enabled, and for External Passthrough Network Load
6421 # Balancers when the haPolicy fastIpMove is enabled.
6422 #
6423 # This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
6424 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
6425 # Load Balancers.
6426 #
6427 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
6428 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
6429 # endpoints in the local zone.
6430 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
6431 # possible values are:
6432 #
6433 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
6434 # is disabled. The load balancer distributes new connections to all
6435 # healthy backend endpoints across all zones.
6436 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
6437 # enabled. The load balancer distributes new connections to all healthy
6438 # backend endpoints in the local zone only. If there are no healthy
6439 # backend endpoints in the local zone, the load balancer distributes
6440 # new connections to all backend endpoints in the local zone.
6441 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
6442 # enabled. The load balancer distributes new connections to all healthy
6443 # backend endpoints in the local zone only. If there aren&#x27;t enough
6444 # healthy backend endpoints in the local zone, the load balancer
6445 # distributes new connections to all healthy backend endpoints across all
6446 # zones.
6447 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
6448 # of healthy backend endpoints in a zone to the count of backend
6449 # endpoints in that same zone is equal to or above this threshold, the
6450 # load balancer distributes new connections to all healthy endpoints in
6451 # the local zone only. When the ratio of the count of healthy backend
6452 # endpoints in a zone to the count of backend endpoints in that same
6453 # zone is below this threshold, the load balancer distributes all new
6454 # connections to all healthy endpoints across all zones.
6455 },
6456 },
6457 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
6458 # the backend service.
6459 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
6460 # service.
6461 },
6462 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
6463 # load balancing pool of each individual proxy instance that processes the
6464 # traffic for the given backend service. If not set, this feature is
6465 # considered disabled.
6466 #
6467 # Results of the outlier detection algorithm (ejection of endpoints from the
6468 # load balancing pool and returning them back to the pool) are executed
6469 # independently by each proxy instance of the load balancer. In most cases,
6470 # more than one proxy instance handles the traffic received by a backend
6471 # service. Thus, it is possible that an unhealthy endpoint is detected and
6472 # ejected by only some of the proxies, and while this happens, other proxies
6473 # may continue to send requests to the same unhealthy endpoint until they
6474 # detect and eject the unhealthy endpoint.
6475 #
6476 # Applicable backend endpoints can be:
6477 #
6478 # - VM instances in an Instance Group
6479 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
6480 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
6481 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
6482 # Functions Services
6483 # - Private Service Connect NEGs, that resolve to
6484 # Google-managed regional API endpoints or managed services published using
6485 # Private Service Connect
6486 #
6487 #
6488 #
6489 # Applicable backend service types can be:
6490 #
6491 # - A global backend service with the loadBalancingScheme set to
6492 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
6493 # - A regional backend
6494 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
6495 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
6496 # supported for Serverless NEGs.
6497 #
6498 #
6499 #
6500 # Not supported when the backend service is referenced by a URL map that is
6501 # bound to target gRPC proxy that has validateForProxyless field set to true.
6502 # pool for the backend service.
6503 &quot;baseEjectionTime&quot;: { # A Duration represents a fixed-length span of time represented # The base time that a backend endpoint is ejected for. Defaults to 30000ms
6504 # or 30s.
6505 #
6506 # After a backend endpoint is returned back to the load balancing pool, it
6507 # can be ejected again in another ejection analysis. Thus, the total ejection
6508 # time is equal to the base ejection time multiplied by the number of times
6509 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
6510 # as a count of seconds and fractions of seconds at nanosecond
6511 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6512 # or &quot;month&quot;. Range is approximately 10,000 years.
6513 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6514 # Durations less than one second are represented with a 0
6515 # `seconds` field and a positive `nanos` field. Must be from 0
6516 # to 999,999,999 inclusive.
6517 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6518 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6519 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6520 },
6521 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
6522 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
6523 # return code qualifies as an error. Defaults to 5.
6524 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
6525 # connection errors that are mapped to one of those status codes) before a
6526 # consecutive gateway failure ejection occurs. Defaults to 3.
6527 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6528 # outlier status is detected through consecutive 5xx. This setting can be
6529 # used to disable ejection or to ramp it up slowly. Defaults to 0.
6530 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6531 # outlier status is detected through consecutive gateway failures. This
6532 # setting can be used to disable ejection or to ramp it up slowly. Defaults
6533 # to 100.
6534 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6535 # outlier status is detected through success rate statistics. This setting
6536 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
6537 #
6538 # Not supported when the backend service uses Serverless NEG.
6539 &quot;interval&quot;: { # A Duration represents a fixed-length span of time represented # Time interval between ejection analysis sweeps. This can result in both new
6540 # ejections and backend endpoints being returned to service. The interval is
6541 # equal to the number of seconds as defined in
6542 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
6543 # in outlierDetection.interval.nanos. Defaults to 1 second.
6544 # as a count of seconds and fractions of seconds at nanosecond
6545 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6546 # or &quot;month&quot;. Range is approximately 10,000 years.
6547 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6548 # Durations less than one second are represented with a 0
6549 # `seconds` field and a positive `nanos` field. Must be from 0
6550 # to 999,999,999 inclusive.
6551 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6552 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6553 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6554 },
6555 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
6556 # backend service that can be ejected if the ejection conditions are met.
6557 # Defaults to 50%.
6558 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
6559 # enough request volume to detect success rate outliers. If the number of
6560 # backend endpoints is fewer than this setting, outlier detection via success
6561 # rate statistics is not performed for any backend endpoint in the load
6562 # balancing pool. Defaults to 5.
6563 #
6564 # Not supported when the backend service uses Serverless NEG.
6565 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
6566 # (as defined by the interval duration above) to include this backend
6567 # endpoint in success rate based outlier detection. If the volume is lower
6568 # than this setting, outlier detection via success rate statistics is not
6569 # performed for that backend endpoint. Defaults to 100.
6570 #
6571 # Not supported when the backend service uses Serverless NEG.
6572 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
6573 # outlier ejection. The ejection threshold is the difference between the mean
6574 # success rate, and the product of this factor and the standard deviation of
6575 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
6576 # is divided by a thousand to get a double. That is, if the desired factor
6577 # is 1.9, the runtime value should be 1900. Defaults to 1900.
6578 #
6579 # Not supported when the backend service uses Serverless NEG.
6580 },
6581 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6582 # as part of resource payload.
6583 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6584 # Tag keys and values have the same definition as resource
6585 # manager tags. The field is allowed for INSERT
6586 # only. The keys/values to set on the resource should be specified in
6587 # either ID { : } or Namespaced format
6588 # { : }.
6589 # For example the following are valid inputs:
6590 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6591 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6592 # Note:
6593 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6594 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6595 &quot;a_key&quot;: &quot;A String&quot;,
6596 },
6597 },
6598 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
6599 # the backend. The default value is 80.
6600 # For internal passthrough Network Load Balancers and external passthrough
6601 # Network Load Balancers, omit port.
6602 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
6603 # communication to the backend VMs in that group. The
6604 # named port must be [defined on each backend instance
6605 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
6606 # This parameter has no meaning if the backends are NEGs. For internal
6607 # passthrough Network Load Balancers and external passthrough Network Load
6608 # Balancers, omit port_name.
6609 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
6610 # with backends.
6611 #
6612 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
6613 # depending on the chosen load balancer or Traffic Director configuration.
6614 # Refer to the documentation for the load balancers or for Traffic Director
6615 # for more information.
6616 #
6617 # Must be set to GRPC when the backend service is referenced by a URL map
6618 # that is bound to target gRPC proxy.
6619 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
6620 # resides. This field is not applicable to global backend services.
6621 # You must specify this field as part of the HTTP request URL. It is
6622 # not settable as a field in the request body.
6623 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
6624 # backend service.
6625 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
6626 # service. This field is applicable to a global backend service with the
6627 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
6628 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
6629 &quot;awsV4Authentication&quot;: { # Contains the configurations necessary to generate a signature for access to # The configuration needed to generate a signature for access to private
6630 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
6631 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
6632 # private storage buckets that support Signature Version 4 for authentication.
6633 # The service name for generating the authentication header will always default
6634 # to &#x27;s3&#x27;.
6635 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
6636 # creating a backend that uses AWS v4 signature authentication, but will not
6637 # be returned as part of the configuration when queried with a REST API GET
6638 # request.
6639 #
6640 # @InputOnly
6641 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
6642 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
6643 # keep track of different iterations of your access key.
6644 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
6645 # the name of the region your cloud uses to host your origin. For example,
6646 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
6647 },
6648 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
6649 # that describes how clients should authenticate with this service&#x27;s
6650 # backends.
6651 #
6652 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
6653 # to INTERNAL_SELF_MANAGED.
6654 #
6655 # If left blank, communications are not encrypted.
6656 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
6657 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
6658 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
6659 # specified values, the communication continues. Otherwise, it fails. This
6660 # additional check enables the client to verify that the server is authorized
6661 # to run the requested service.
6662 #
6663 # Note that the contents of the server
6664 # certificate&#x27;s subjectAltName field are configured by the
6665 # Public Key Infrastructure which provisions server identities.
6666 #
6667 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
6668 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
6669 # mode).
6670 &quot;A String&quot;,
6671 ],
6672 },
6673 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6674 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
6675 #
6676 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
6677 # If set, lists of backends and health checks must be both empty.
6678 &quot;A String&quot;,
6679 ],
6680 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
6681 #
6682 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
6683 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
6684 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
6685 #
6686 # Only NONE and HEADER_FIELD are supported
6687 # when the backend service is referenced by a URL map that is bound to
6688 # target gRPC proxy that has validateForProxyless field set to true.
6689 #
6690 # For more details, see:
6691 # [Session
6692 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
6693 #
6694 # sessionAffinity cannot be specified with haPolicy.
6695 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
6696 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
6697 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6698 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6699 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6700 # as a count of seconds and fractions of seconds at nanosecond
6701 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6702 # or &quot;month&quot;. Range is approximately 10,000 years.
6703 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6704 # Durations less than one second are represented with a 0
6705 # `seconds` field and a positive `nanos` field. Must be from 0
6706 # to 999,999,999 inclusive.
6707 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6708 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6709 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6710 },
6711 },
6712 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
6713 # Currently this is applicable only for Internal TCP/UDP load balancing,
6714 # Internal HTTP(S) load balancing and Traffic Director.
6715 &quot;policy&quot;: &quot;A String&quot;,
6716 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
6717 # each service mesh client.
6718 #
6719 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
6720 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
6721 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
6722 # `INTERNAL_SELF_MANAGED`.
6723 #
6724 # `subset_size` is optional for Internal HTTP(S) load balancing
6725 # and required for Traffic Director.
6726 #
6727 # If you do not provide this value, Cloud Load Balancing will calculate it
6728 # dynamically to optimize the number of proxies/clients visible to each
6729 # backend and vice versa.
6730 #
6731 # Must be greater than 0. If `subset_size` is larger than the number of
6732 # backends/endpoints, then subsetting is disabled.
6733 },
6734 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
6735 # type of load balancer. For more information see,
6736 # Backend service settings.
6737 # The default is 30 seconds.
6738 # The full range of timeout values allowed goes from 1
6739 # through 2,147,483,647 seconds.
6740 #
6741 # This value can be overridden in the PathMatcher configuration of the
6742 # UrlMap that references this backend service.
6743 #
6744 # Not supported when the backend service is referenced by a URL map that is
6745 # bound to target gRPC proxy that has validateForProxyless field set to true.
6746 # Instead, use maxStreamDuration.
6747 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
6748 # when the backend protocol is SSL, HTTPS or HTTP2.
6749 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
6750 # networksecurity.googleapis.com namespace. Can be used in authenticating
6751 # TLS connections to the backend, as specified by the authenticationMode
6752 # field. Can only be specified if authenticationMode is not NONE.
6753 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
6754 #
6755 #
6756 # Use this property to configure the load balancer back-end to use
6757 # certificates and roots of trust provisioned by the Managed Workload
6758 # Identity system.
6759 #
6760 # The `identity` property is the
6761 # fully-specified SPIFFE ID to use in the SVID presented by the Load
6762 # Balancer Workload.
6763 #
6764 # The SPIFFE ID must be a resource starting with the
6765 # `trustDomain` property value, followed by the path to the Managed
6766 # Workload Identity.
6767 #
6768 # Supported SPIFFE ID format:
6769 #
6770 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
6771 #
6772 #
6773 # The Trust Domain within the Managed Identity must refer to a valid
6774 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
6775 # will be inherited from the Workload Identity Pool.
6776 #
6777 # Restrictions:
6778 #
6779 # - If you set the `identity` property, you cannot manually set
6780 # the following fields:
6781 # - tlsSettings.sni
6782 # - tlsSettings.subjectAltNames
6783 # - tlsSettings.authenticationConfig
6784 #
6785 #
6786 # When defining a `identity` for a RegionBackendServices, the
6787 # corresponding Workload Identity Pool must have a ca_pool
6788 # configured in the same region.
6789 #
6790 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
6791 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
6792 # balancer sends this string as the SNI hostname in the TLS connection to
6793 # the backend, and requires that this string match a Subject Alternative
6794 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
6795 # NEG backend, if the SNI is specified here, the load balancer uses it
6796 # regardless of whether the Regional Internet NEG is specified with FQDN or
6797 # IP address and port. When both sni and subjectAltNames[] are specified,
6798 # the load balancer matches the backend certificate&#x27;s SAN only to
6799 # subjectAltNames[].
6800 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
6801 # verifies during a TLS handshake with the backend. When the server
6802 # presents its X.509 certificate to the Load Balancer, the Load Balancer
6803 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
6804 # match one of the subjectAltNames in the list. This field is limited to 5
6805 # entries. When both sni and subjectAltNames[] are specified, the load
6806 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
6807 { # A Subject Alternative Name that the load balancer matches against the SAN
6808 # field in the TLS certificate provided by the backend, specified as either
6809 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
6810 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
6811 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
6812 },
6813 ],
6814 },
6815 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
6816 {
6817 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
6818 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
6819 # and ForwardingRule.
6820 },
6821 ],
6822 },
6823 ],
6824 &quot;kind&quot;: &quot;compute#usableBackendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend
6825 # services.
6826 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
6827 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
6828 # the query parameter pageToken in the next list request.
6829 # Subsequent list requests will have their own nextPageToken to
6830 # continue paging through the results.
6831 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
6832 &quot;warning&quot;: { # [Output Only] Informational warning message.
6833 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6834 # Engine returns NO_RESULTS_ON_PAGE if there
6835 # are no results in the response.
6836 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6837 # value format. For example:
6838 #
6839 # &quot;data&quot;: [
6840 # {
6841 # &quot;key&quot;: &quot;scope&quot;,
6842 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6843 # }
6844 {
6845 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6846 # returned. For example, for warnings where there are no results in a list
6847 # request for a particular zone, this key might be scope and
6848 # the key value might be the zone name. Other examples might be a key
6849 # indicating a deprecated resource and a suggested replacement, or a
6850 # warning about invalid network settings (for example, if an instance
6851 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6852 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6853 },
6854 ],
6855 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6856 },
6857 }</pre>
6858 </div>
6859
6860 <div class="method">
6861 <code class="details" id="listUsable_next">listUsable_next()</code>
6862 <pre>Retrieves the next page of results.
6863
6864 Args:
6865 previous_request: The request for the previous page. (required)
6866 previous_response: The response from the request for the previous page. (required)
6867
6868 Returns:
6869 A request object that you can call &#x27;execute()&#x27; on to request the next
6870 page. Returns None if there are no more items in the collection.
6871 </pre>
6872 </div>
6873
6874 <div class="method">
6875 <code class="details" id="list_next">list_next()</code>
6876 <pre>Retrieves the next page of results.
6877
6878 Args:
6879 previous_request: The request for the previous page. (required)
6880 previous_response: The response from the request for the previous page. (required)
6881
6882 Returns:
6883 A request object that you can call &#x27;execute()&#x27; on to request the next
6884 page. Returns None if there are no more items in the collection.
6885 </pre>
6886 </div>
6887
6888 <div class="method">
6889 <code class="details" id="patch">patch(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
6890 <pre>Updates the specified regional BackendService resource with the data
6891 included in the request. For more information, see
6892 Understanding backend services This method
6893 supports PATCH semantics and uses the JSON merge
6894 patch format and processing rules.
6895
6896 Args:
6897 project: string, Project ID for this request. (required)
6898 region: string, Name of the region scoping this request. (required)
6899 backendService: string, Name of the BackendService resource to patch. (required)
6900 body: object, The request body.
6901 The object takes the form of:
6902
6903 { # Represents a Backend Service resource.
6904 #
6905 # A backend service defines how Google Cloud load balancers distribute traffic.
6906 # The backend service configuration contains a set of values, such as the
6907 # protocol used to connect to backends, various distribution and session
6908 # settings, health checks, and timeouts. These settings provide fine-grained
6909 # control over how your load balancer behaves. Most of the settings have
6910 # default values that allow for easy configuration if you need to get started
6911 # quickly.
6912 #
6913 # Backend services in Google Compute Engine can be either regionally or
6914 # globally scoped.
6915 #
6916 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
6917 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
6918 #
6919 # For more information, seeBackend
6920 # Services.
6921 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
6922 # Load Balancers and Traffic Director and requires
6923 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
6924 #
6925 # If set to 0, the cookie is non-persistent and lasts only until
6926 # the end of the browser session (or equivalent). The maximum allowed value
6927 # is two weeks (1,209,600).
6928 #
6929 # Not supported when the backend service is referenced by a URL map that is
6930 # bound to target gRPC proxy that has validateForProxyless field set to true.
6931 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
6932 { # Message containing information of one individual backend.
6933 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
6934 # handle additional traffic or is fully loaded. For usage guidelines, see
6935 # Connection balancing mode.
6936 #
6937 # Backends must use compatible balancing modes. For more information, see
6938 # Supported balancing modes and target capacity settings and
6939 # Restrictions and guidance for instance groups.
6940 #
6941 # Note: Currently, if you use the API to configure incompatible balancing
6942 # modes, the configuration might be accepted even though it has no impact
6943 # and is ignored. Specifically, Backend.maxUtilization is ignored when
6944 # Backend.balancingMode is RATE. In the future, this incompatible combination
6945 # will be rejected.
6946 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
6947 # mode.
6948 # The default value is 1, which means the group serves up to
6949 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
6950 # completely drained, offering 0% of its available capacity. The valid ranges
6951 # are 0.0 and [0.1,1.0].
6952 # You cannot configure a setting larger than 0 and smaller than0.1.
6953 # You cannot configure a setting of 0 when there is only one
6954 # backend attached to the backend service.
6955 #
6956 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
6957 # internet NEGs, regional serverless NEGs, and PSC NEGs.
6958 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
6959 # BalancingMode.
6960 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
6961 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
6962 # Monitoring, but is not used for load balancing.
6963 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
6964 # balancing mode. The valid range is [0.0, 1.0].
6965 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6966 # long and match the regular expression
6967 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6968 # first character must be a lowercase letter, and all following
6969 # characters must be a dash, period, underscore, lowercase letter, or
6970 # digit, except the last character, which cannot be a dash, period, or
6971 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6972 # field can only be used for a global or regional backend service with the
6973 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6974 },
6975 ],
6976 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6977 # create the resource.
6978 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
6979 # failover backend can be configured for a given BackendService.
6980 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
6981 # group or network endpoint
6982 # group (NEG) resource. To determine what types of backends a load
6983 # balancer supports, see the [Backend services
6984 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
6985 #
6986 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
6987 # or NEG. Partial URLs are not supported.
6988 #
6989 # If haPolicy is specified, backends must refer to NEG resources of type
6990 # GCE_VM_IP.
6991 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6992 # guidelines, seeConnection
6993 # balancing mode and Utilization
6994 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
6995 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6996 # guidelines, seeConnection
6997 # balancing mode and Utilization
6998 # balancing mode.
6999 #
7000 # Not available if the backend&#x27;s balancingMode isRATE.
7001 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
7002 # For usage guidelines, seeConnection
7003 # balancing mode and Utilization
7004 # balancing mode.
7005 #
7006 # Not available if the backend&#x27;s balancingMode isRATE.
7007 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
7008 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
7009 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
7010 # Not available if backend&#x27;s balancingMode is RATE
7011 # or CONNECTION.
7012 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
7013 # Not available if backend&#x27;s balancingMode is RATE
7014 # or CONNECTION.
7015 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
7016 # usage guidelines, seeRate
7017 # balancing mode and Utilization
7018 # balancing mode.
7019 #
7020 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7021 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
7022 # guidelines, seeRate
7023 # balancing mode and Utilization
7024 # balancing mode.
7025 #
7026 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7027 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
7028 # guidelines, seeRate
7029 # balancing mode and Utilization
7030 # balancing mode.
7031 #
7032 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7033 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
7034 #
7035 # For usage guidelines, seeUtilization
7036 # balancing mode.
7037 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
7038 # the backend.
7039 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
7040 },
7041 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
7042 # sending traffic to backends with default preference. The possible values
7043 # are:
7044 #
7045 # - PREFERRED: Backends with this preference level will be
7046 # filled up to their capacity limits first, based on RTT.
7047 # - DEFAULT: If preferred backends don&#x27;t have enough
7048 # capacity, backends in this layer would be used and traffic would be
7049 # assigned based on the load balancing algorithm you use. This is the
7050 # default
7051 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
7052 # Attachment).
7053 # e.g.
7054 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
7055 # for Cloud Run service.
7056 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
7057 # for PSC Service Attachment.
7058 &quot;trafficDuration&quot;: &quot;A String&quot;,
7059 },
7060 ],
7061 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
7062 # specified load balancer types.
7063 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
7064 # Pragma or Authorization headers. Up to 5 headers can be specified.
7065 # The cache is bypassed for all cdnPolicy.cacheMode settings.
7066 { # Bypass the cache when the specified request headers are present,
7067 # e.g. Pragma or Authorization headers. Values are case insensitive.
7068 # The presence of such a header overrides the cache_mode setting.
7069 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
7070 # Values are case-insensitive.
7071 },
7072 ],
7073 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
7074 # CDN.
7075 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
7076 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
7077 &quot;A String&quot;,
7078 ],
7079 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
7080 # The name=value pair will be used in the cache key Cloud CDN generates.
7081 &quot;A String&quot;,
7082 ],
7083 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
7084 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
7085 # query_string_whitelist and query_string_blacklist. If neither is set, the
7086 # entire query string will be included. If false, the query string will be
7087 # excluded from the cache key entirely.
7088 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
7089 # parameters will be included. Either specify query_string_whitelist or
7090 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
7091 # not treated as delimiters.
7092 &quot;A String&quot;,
7093 ],
7094 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
7095 # parameters will be excluded. Either specify query_string_whitelist or
7096 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
7097 # not treated as delimiters.
7098 &quot;A String&quot;,
7099 ],
7100 },
7101 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
7102 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
7103 # headers to cache content. Responses without these headers will not be
7104 # cached at Google&#x27;s edge, and will require a full trip to the origin on
7105 # every request, potentially impacting performance and increasing load on
7106 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
7107 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
7108 # Warning: this may result in Cloud CDN caching private,
7109 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
7110 # including common image formats, media (video and audio), and web assets
7111 # (JavaScript and CSS). Requests and responses that are marked as
7112 # uncacheable, as well as dynamic content (including HTML), will not be
7113 # cached.
7114 #
7115 # If no value is provided for cdnPolicy.cacheMode, it defaults
7116 # to CACHE_ALL_STATIC.
7117 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
7118 # used to clamp the max-age (or Expires) value sent to the client. With
7119 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
7120 # response max-age directive, along with a &quot;public&quot; directive. For
7121 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
7122 # from the origin (if specified), or else sets the response max-age
7123 # directive to the lesser of the client_ttl and default_ttl, and also
7124 # ensures a &quot;public&quot; cache-control directive is present.
7125 # If a client TTL is not specified, a default value (1 hour) will be used.
7126 # The maximum allowed value is 31,622,400s (1 year).
7127 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
7128 # responses that do not have an existing valid TTL (max-age or s-maxage).
7129 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
7130 # The value of defaultTTL cannot be set to a value greater than that of
7131 # maxTTL, but can be equal.
7132 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
7133 # will overwrite the TTL set in all responses. The maximum allowed value is
7134 # 31,622,400s (1 year), noting that infrequently accessed objects may be
7135 # evicted from the cache before the defined TTL.
7136 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
7137 # origin.
7138 # Cache directives that attempt to set a max-age or s-maxage higher than
7139 # this, or an Expires header more than maxTTL seconds in the future will
7140 # be capped at the value of maxTTL, as if it were the value of an
7141 # s-maxage Cache-Control directive.
7142 # Headers sent to the client will not be modified.
7143 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
7144 # The maximum allowed value is 31,622,400s (1 year), noting that
7145 # infrequently accessed objects may be evicted from the cache before
7146 # the defined TTL.
7147 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
7148 # to apply fine-grained caching for common errors or redirects.
7149 # This can reduce the load on your origin and improve end-user
7150 # experience by reducing response latency.
7151 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
7152 # negative caching applies to responses with the specified response code
7153 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
7154 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
7155 # to all responses with the specified response code, and override any
7156 # caching headers.
7157 # By default, Cloud CDN will apply the following default TTLs to these
7158 # status codes:
7159 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
7160 # HTTP 404 (Not Found), 410 (Gone),
7161 # 451 (Unavailable For Legal Reasons): 120s
7162 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
7163 # These defaults can be overridden in negative_caching_policy.
7164 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
7165 # negative_caching must be enabled to configure negative_caching_policy.
7166 # Omitting the policy and leaving negative_caching enabled will use
7167 # Cloud CDN&#x27;s default cache TTLs.
7168 # Note that when specifying an explicit negative_caching_policy, you
7169 # should take care to specify a cache TTL for all response codes
7170 # that you wish to cache. Cloud CDN will not apply any default
7171 # negative caching when a policy exists.
7172 { # Specify CDN TTLs for response error codes.
7173 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
7174 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
7175 # specified as values, and you cannot specify a status code more than
7176 # once.
7177 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
7178 # corresponding status code.
7179 # The maximum allowed value is 1800s (30 minutes), noting that
7180 # infrequently accessed objects may be evicted from the cache before the
7181 # defined TTL.
7182 },
7183 ],
7184 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
7185 # requests into a small number of requests to the origin.
7186 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
7187 # content with the origin, or when an error is encountered when refreshing
7188 # the cache.
7189 # This setting defines the default &quot;max-stale&quot; duration for any cached
7190 # responses that do not specify a max-stale directive. Stale responses that
7191 # exceed the TTL configured here will not be served. The default limit
7192 # (max-stale) is 86400s (1 day), which will allow stale content to be
7193 # served up to this limit beyond the max-age (or s-maxage) of a cached
7194 # response.
7195 # The maximum allowed value is 604800 (1 week).
7196 # Set this to zero (0) to disable serve-while-stale.
7197 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
7198 # considered fresh. After this time period, the response will be
7199 # revalidated before being served. Defaults to 1hr (3600s). When serving
7200 # responses to signed URL requests, Cloud CDN will internally behave as
7201 # though all responses from this backend had a &quot;Cache-Control:
7202 # public, max-age=[TTL]&quot; header, regardless of any existing
7203 # Cache-Control header. The actual headers served in responses will not be
7204 # altered.
7205 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
7206 &quot;A String&quot;,
7207 ],
7208 },
7209 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
7210 # backend service.
7211 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
7212 # as a count of seconds and fractions of seconds at nanosecond
7213 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7214 # or &quot;month&quot;. Range is approximately 10,000 years.
7215 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7216 # Durations less than one second are represented with a 0
7217 # `seconds` field and a positive `nanos` field. Must be from 0
7218 # to 999,999,999 inclusive.
7219 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7220 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7221 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7222 },
7223 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
7224 # there is no limit.
7225 #
7226 # Not supported when the backend service is referenced by a URL map that is
7227 # bound to target gRPC proxy that has validateForProxyless field set to true.
7228 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
7229 # not specified, there is no limit.
7230 #
7231 # Not supported when the backend service is referenced by a URL map that is
7232 # bound to target gRPC proxy that has validateForProxyless field set to true.
7233 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
7234 # service. If not specified, there is no limit.
7235 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
7236 # This parameter is respected by both the HTTP/1.1 and HTTP/2
7237 # implementations. If not specified, there is no limit. Setting this
7238 # parameter to 1 will effectively disable keep alive.
7239 #
7240 # Not supported when the backend service is referenced by a URL map that is
7241 # bound to target gRPC proxy that has validateForProxyless field set to true.
7242 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
7243 # not specified, the default is 1.
7244 #
7245 # Not supported when the backend service is referenced by a URL map that is
7246 # bound to target gRPC proxy that has validateForProxyless field set to true.
7247 },
7248 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
7249 # the client&#x27;s Accept-Encoding header.
7250 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
7251 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
7252 # instance. For supported load balancers and protocols, as described inEnabling
7253 # connection draining.
7254 },
7255 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
7256 # tracking policy settings are only available for external passthrough
7257 # Network Load Balancers and internal passthrough Network Load Balancers.
7258 #
7259 # connectionTrackingPolicy cannot be specified with haPolicy.
7260 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
7261 # value is DEFAULT_FOR_PROTOCOL.
7262 #
7263 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
7264 # persist on unhealthy backends only for connection-oriented protocols
7265 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
7266 # Affinity is configured for 5-tuple. They do not persist forUDP.
7267 #
7268 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
7269 # the existing connections on the unhealthy backend are never persisted on
7270 # the unhealthy backend. They are always diverted to newly selected healthy
7271 # backends (unless all backends are unhealthy).
7272 #
7273 # If set to ALWAYS_PERSIST, existing connections always
7274 # persist on unhealthy backends regardless of protocol and session
7275 # affinity. It is generally not recommended to use this mode overriding the
7276 # default.
7277 #
7278 # For more details, see [Connection Persistence for Network Load
7279 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
7280 # and [Connection Persistence for Internal TCP/UDP Load
7281 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
7282 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
7283 # Balancers. This option is not available publicly.
7284 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
7285 # matching traffic (in seconds).
7286 #
7287 # For internal passthrough Network Load Balancers:
7288 #
7289 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
7290 # - It can be set only if Connection Tracking is less than 5-tuple
7291 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
7292 # Mode is PER_SESSION).
7293 #
7294 #
7295 #
7296 # For external passthrough Network Load Balancers the default is 60
7297 # seconds. This option is not available publicly.
7298 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
7299 # options:
7300 #
7301 # - PER_CONNECTION: This is the default mode. The Connection
7302 # Tracking is performed as per the Connection Key (default Hash Method) for
7303 # the specific protocol.
7304 # - PER_SESSION: The Connection Tracking is performed as per
7305 # the configured Session Affinity. It matches the configured Session
7306 # Affinity.
7307 #
7308 #
7309 #
7310 # For more details, see [Tracking Mode for Network Load
7311 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
7312 # and [Tracking Mode for Internal TCP/UDP Load
7313 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
7314 },
7315 &quot;consistentHash&quot;: { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session
7316 # affinity based on HTTP headers, cookies or other properties. This load
7317 # balancing policy is applicable only for HTTP connections. The affinity to a
7318 # particular destination host will be lost when one or more hosts are
7319 # added/removed from the destination service. This field specifies parameters
7320 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
7321 #
7322 # This field is applicable to either:
7323 #
7324 # - A regional backend service with the service protocol set to HTTP,
7325 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7326 # INTERNAL_MANAGED.
7327 # - A global backend service with the
7328 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7329 &quot;httpCookie&quot;: { # The information about the HTTP Cookie on which the hash function is based # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
7330 # be used as the hash key for the consistent hash load balancer. If the
7331 # cookie is not present, it will be generated. This field is applicable if
7332 # the sessionAffinity is set to HTTP_COOKIE.
7333 #
7334 # Not supported when the backend service is referenced by a URL map that is
7335 # bound to target gRPC proxy that has validateForProxyless field set to true.
7336 # for load balancing policies that use a consistent hash.
7337 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7338 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7339 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7340 # as a count of seconds and fractions of seconds at nanosecond
7341 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7342 # or &quot;month&quot;. Range is approximately 10,000 years.
7343 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7344 # Durations less than one second are represented with a 0
7345 # `seconds` field and a positive `nanos` field. Must be from 0
7346 # to 999,999,999 inclusive.
7347 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7348 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7349 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7350 },
7351 },
7352 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
7353 # applicable if the sessionAffinity is set toHEADER_FIELD.
7354 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
7355 # 1024. Larger ring sizes result in more granular load distributions. If the
7356 # number of hosts in the load balancing pool is larger than the ring size,
7357 # each host will be assigned a single virtual node.
7358 },
7359 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7360 # text format.
7361 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
7362 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
7363 # locality_lb_policy.
7364 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
7365 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
7366 # long and match the regular expression
7367 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
7368 # first character must be a lowercase letter, and all following
7369 # characters must be a dash, period, underscore, lowercase letter, or
7370 # digit, except the last character, which cannot be a dash, period, or
7371 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
7372 # field can only be used for a global or regional backend service with the
7373 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
7374 },
7375 ],
7376 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
7377 # custom
7378 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7379 &quot;A String&quot;,
7380 ],
7381 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
7382 # custom
7383 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7384 &quot;A String&quot;,
7385 ],
7386 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7387 # create the resource.
7388 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
7389 # backend service with dynamic forwarding feature which together with Service
7390 # Extension allows customized and complex routing logic.
7391 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
7392 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
7393 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
7394 },
7395 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
7396 # service. Some ranges are restricted: Restricted
7397 # ranges.
7398 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
7399 },
7400 },
7401 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
7402 # this backend service.
7403 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
7404 # global external Application Load Balancer.
7405 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
7406 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
7407 #
7408 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
7409 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
7410 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
7411 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
7412 # externalManagedMigrationTestingPercentage.
7413 #
7414 # Rolling back a migration requires the states to be set in reverse order. So
7415 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
7416 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
7417 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
7418 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
7419 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
7420 # external Application Load Balancer.
7421 #
7422 # The value of this field must be in the range [0, 100].
7423 #
7424 # Session affinity options will slightly affect this routing behavior, for
7425 # more details, see:Session
7426 # Affinity.
7427 #
7428 # This value can only be set if the loadBalancingScheme in the BackendService
7429 # is set to EXTERNAL (when using the classic Application Load Balancer) and
7430 # the migration state is TEST_BY_PERCENTAGE.
7431 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
7432 # as a backup (failover) backend.
7433 # For load balancers that have configurable failover:
7434 # [Internal passthrough Network Load
7435 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7436 # and [external passthrough Network Load
7437 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7438 #
7439 # failoverPolicy cannot be specified with haPolicy.
7440 # failover:
7441 # [Internal passthrough Network Load
7442 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7443 # and [external passthrough
7444 # Network Load
7445 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7446 # On failover or failback, this field indicates whether connection draining
7447 # will be honored. Google Cloud has a fixed connection draining timeout of
7448 # 10 minutes. A setting of true terminates existing TCP
7449 # connections to the active pool during failover and failback, immediately
7450 # draining traffic. A setting of false allows existing TCP
7451 # connections to persist, even on VMs no longer in the active pool, for up
7452 # to the duration of the connection draining timeout (10 minutes).
7453 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
7454 #
7455 # The default is false.
7456 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
7457 # load balancer are dropped when all primary and all backup backend VMs are
7458 # unhealthy.If set to false, connections are distributed
7459 # among all primary VMs when all primary and all backup backend VMs are
7460 # unhealthy.
7461 # For load balancers that have configurable
7462 # failover:
7463 # [Internal passthrough
7464 # Network Load
7465 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7466 # and [external passthrough
7467 # Network Load
7468 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7469 # The default is false.
7470 &quot;failoverRatio&quot;: 3.14, # The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
7471 # failover when the number of healthy primary VMs equals zero.
7472 # For all other values, the load balancer performs a failover when the
7473 # total number of healthy primary VMs is less than this ratio.
7474 # For load balancers that have configurable
7475 # failover:
7476 # [Internal TCP/UDP Load
7477 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7478 # and [external TCP/UDP Load
7479 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7480 },
7481 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
7482 # This field is used in optimistic locking. This field will be ignored when
7483 # inserting a BackendService. An up-to-date fingerprint must be provided in
7484 # order to update the BackendService, otherwise the request will
7485 # fail with error 412 conditionNotMet.
7486 #
7487 # To see the latest fingerprint, make a get() request to
7488 # retrieve a BackendService.
7489 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
7490 # Protocol Forwarding.
7491 #
7492 # The backends of this regional backend service must only specify zonal
7493 # network endpoint groups (NEGs) of type GCE_VM_IP.
7494 #
7495 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
7496 # regional backend service must set the network field. All zonal NEGs must
7497 # belong to the same network. However, individual NEGs can
7498 # belong to different subnetworks of that network.
7499 #
7500 # When haPolicy is specified, the set of attached network endpoints across
7501 # all backends comprise an High Availability domain from which one endpoint
7502 # is selected as the active endpoint (the leader) that receives all
7503 # traffic.
7504 #
7505 # haPolicy can be added only at backend service creation time. Once set up,
7506 # it cannot be deleted.
7507 #
7508 # Note that haPolicy is not for load balancing, and therefore cannot be
7509 # specified with sessionAffinity, connectionTrackingPolicy, and
7510 # failoverPolicy.
7511 #
7512 # haPolicy requires customers to be responsible for tracking backend
7513 # endpoint health and electing a leader among the healthy endpoints.
7514 # Therefore, haPolicy cannot be specified with healthChecks.
7515 #
7516 # haPolicy can only be specified for External Passthrough Network Load
7517 # Balancers and Internal Passthrough Network Load Balancers.
7518 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
7519 # achieve it.
7520 #
7521 # Supported values are:
7522 #
7523 # - DISABLED: Fast IP Move is disabled. You can only use the
7524 # haPolicy.leader API to update the leader.
7525 # - &gt;GARP_RA: Provides a method to very quickly define a new network
7526 # endpoint as the leader. This method is faster than updating the leader
7527 # using the haPolicy.leader API. Fast IP move works as follows: The VM
7528 # hosting the network endpoint that should become the new leader sends
7529 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
7530 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
7531 # temporarily associates the forwarding rule IP address with that VM, and
7532 # both new and in-flight packets are quickly delivered to that VM.
7533 #
7534 #
7535 #
7536 # Note the important properties of the Fast IP Move functionality:
7537 #
7538 # - The GARP/RA-initiated re-routing stays active for approximately 20
7539 # minutes. After triggering fast failover, you must also
7540 # appropriately set the haPolicy.leader.
7541 # - The new leader instance should continue to send GARP/RA packets
7542 # periodically every 10 seconds until at least 10 minutes after updating
7543 # the haPolicy.leader (but stop immediately if it is no longer the leader).
7544 # - After triggering a fast failover, we recommend that you wait at least
7545 # 3 seconds before sending another GARP/RA packet from a different VM
7546 # instance to avoid race conditions.
7547 # - Don&#x27;t send GARP/RA packets from different VM
7548 # instances at the same time. If multiple instances continue to send
7549 # GARP/RA packets, traffic might be routed to different destinations in an
7550 # alternating order. This condition ceases when a single instance
7551 # issues a GARP/RA packet.
7552 # - The GARP/RA request always takes priority over the leader API.
7553 # Using the haPolicy.leader API to change the leader to a different
7554 # instance will have no effect until the GARP/RA request becomes
7555 # inactive.
7556 # - The GARP/RA packets should follow the GARP/RA
7557 # Packet Specifications..
7558 # - When multiple forwarding rules refer to a regional backend service,
7559 # you need only send a GARP or RA packet for a single forwarding rule
7560 # virtual IP. The virtual IPs for all forwarding rules targeting the same
7561 # backend service will also be moved to the sender of the GARP or RA
7562 # packet.
7563 #
7564 #
7565 #
7566 # The following are the Fast IP Move limitations (that is, when fastIPMove
7567 # is not DISABLED):
7568 #
7569 # - Multiple forwarding rules cannot use the same IP address if one of
7570 # them refers to a regional backend service with fastIPMove.
7571 # - The regional backend service must set the network field, and all
7572 # NEGs must belong to that network. However, individual
7573 # NEGs can belong to different subnetworks of that network.
7574 # - The maximum number of network endpoints across all backends of a
7575 # backend service with fastIPMove is 32.
7576 # - The maximum number of backend services with fastIPMove that can have
7577 # the same network endpoint attached to one of its backends is 64.
7578 # - The maximum number of backend services with fastIPMove in a VPC in a
7579 # region is 64.
7580 # - The network endpoints that are attached to a backend of a backend
7581 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
7582 # - Traffic directed to the leader by a static route next hop will not be
7583 # redirected to a new leader by fast failover. Such traffic will only be
7584 # redirected once an haPolicy.leader update has taken effect. Only traffic
7585 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
7586 # fast failover.
7587 #
7588 #
7589 # haPolicy.fastIPMove can be set only at backend service creation time.
7590 # Once set, it cannot be updated.
7591 #
7592 # By default, fastIpMove is set to DISABLED.
7593 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
7594 # this service as the active endpoint (the leader) that receives all
7595 # traffic.
7596 #
7597 # When the leader changes, there is no connection draining to persist
7598 # existing connections on the old leader.
7599 #
7600 # You are responsible for selecting a suitable endpoint as the
7601 # leader. For example, preferring a healthy endpoint over unhealthy ones.
7602 # Note that this service does not track backend endpoint health, and
7603 # selects the configured leader unconditionally.
7604 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
7605 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
7606 # that the leader is attached to.
7607 #
7608 # The leader&#x27;s backendGroup must already be specified as a backend of
7609 # this backend service. Removing a backend that is designated as the
7610 # leader&#x27;s backendGroup is not permitted.
7611 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
7612 # designated as the leader.
7613 #
7614 # This network endpoint cannot be detached from the NEG specified in
7615 # the haPolicy.leader.backendGroup until the leader is updated with
7616 # another network endpoint, or the leader is removed from the haPolicy.
7617 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
7618 # instance must already be attached to the NEG specified in the
7619 # haPolicy.leader.backendGroup.
7620 #
7621 # The name must be 1-63 characters long, and comply with RFC1035.
7622 # Authorization requires the following IAM permission on the
7623 # specified resource instance: compute.instances.use
7624 },
7625 },
7626 },
7627 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
7628 # httpsHealthChecks (legacy) resource for health checking this backend
7629 # service. Not all backend services support legacy health checks. See
7630 # Load balancer guide. Currently, at most one health check can be
7631 # specified for each backend service. Backend services with
7632 # instance group or zonal NEG backends must have a health check unless
7633 # haPolicy is specified. Backend services with internet or serverless NEG
7634 # backends must not have a health check.
7635 #
7636 # healthChecks[] cannot be specified with haPolicy.
7637 &quot;A String&quot;,
7638 ],
7639 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
7640 # Not available for internal passthrough Network Load Balancers and external
7641 # passthrough Network Load Balancers.
7642 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
7643 # incoming requests.
7644 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
7645 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
7646 # For security reasons, this value cannot be retrieved via the API.
7647 # Instead, the SHA-256 hash of the value is returned in the
7648 # oauth2ClientSecretSha256 field.
7649 #
7650 # @InputOnly
7651 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
7652 },
7653 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7654 # defined by the server.
7655 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
7656 # from the client to the backend for proxyless gRPC).
7657 # The possible values are:
7658 #
7659 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
7660 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7661 # Group), regardless of traffic from the client to the proxy. Only IPv4
7662 # health checks are used to check the health of the backends. This is the
7663 # default setting.
7664 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
7665 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
7666 # address).
7667 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
7668 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7669 # Group), regardless of traffic from the client to the proxy. Only IPv6
7670 # health checks are used to check the health of the backends.
7671 #
7672 #
7673 #
7674 # This field is applicable to either:
7675 #
7676 # - Advanced global external Application Load Balancer (load balancing
7677 # scheme EXTERNAL_MANAGED),
7678 # - Regional external Application Load
7679 # Balancer,
7680 # - Internal proxy Network Load Balancer (load balancing
7681 # scheme INTERNAL_MANAGED),
7682 # - Regional internal Application Load
7683 # Balancer (load balancing scheme INTERNAL_MANAGED),
7684 # - Traffic
7685 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
7686 # INTERNAL_SELF_MANAGED).
7687 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
7688 # for backend services.
7689 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
7690 # created for one type of load balancer cannot be used with another.
7691 # For more information, refer toChoosing
7692 # a load balancer.
7693 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
7694 # preference. When you use localityLbPolicies, you must set at least one
7695 # value for either the localityLbPolicies[].policy or the
7696 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
7697 # value set in the localityLbPolicy field.
7698 #
7699 # For an example of how to use this field, seeDefine
7700 # a list of preferred policies.
7701 #
7702 # Caution: This field and its children are intended for use in a service mesh
7703 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
7704 # that have this configuration.
7705 { # Container for either a built-in LB policy supported by gRPC or Envoy or
7706 # a custom one implemented by the end user.
7707 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
7708 # deployed with the client.
7709 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
7710 # by a locally installed custom policy implementation.
7711 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
7712 #
7713 # The value should match the name of a custom implementation registered
7714 # on the gRPC clients. It should follow protocol buffer message naming
7715 # conventions and include the full path (for example,
7716 # myorg.CustomLbPolicy). The maximum length is 256 characters.
7717 #
7718 # Do not specify the same custom policy more than once for a
7719 # backend. If you do, the configuration is rejected.
7720 #
7721 # For an example of how to use this field, seeUse
7722 # a custom policy.
7723 },
7724 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
7725 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
7726 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
7727 # about these values, see the description of localityLbPolicy.
7728 #
7729 # Do not specify the same policy more than once for a
7730 # backend. If you do, the configuration is rejected.
7731 },
7732 },
7733 ],
7734 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
7735 # possible values are:
7736 #
7737 # - ROUND_ROBIN: This is a simple policy in which each healthy
7738 # backend is selected in round robin order. This is the default.
7739 # - LEAST_REQUEST: An O(1) algorithm which
7740 # selects two random healthy hosts and picks the host which has fewer active
7741 # requests.
7742 # - RING_HASH: The ring/modulo hash load balancer implements
7743 # consistent hashing to backends. The algorithm has the property that the
7744 # addition/removal of a host from a set of N hosts only affects 1/N of the
7745 # requests.
7746 # - RANDOM: The load balancer selects a random healthy
7747 # host.
7748 # - ORIGINAL_DESTINATION: Backend host is selected
7749 # based on the client connection metadata, i.e., connections are opened to
7750 # the same address as the destination address of the incoming connection
7751 # before the connection was redirected to the load balancer.
7752 # - MAGLEV: used as a drop in replacement for the ring hash
7753 # load balancer. Maglev is not as stable as ring hash but has faster table
7754 # lookup build times and host selection times. For more information about
7755 # Maglev, see Maglev:
7756 # A Fast and Reliable Software Network Load Balancer.
7757 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
7758 # Load Balancing using weights computed from Backend reported Custom Metrics.
7759 # If set, the Backend Service responses are expected to contain non-standard
7760 # HTTP response header field Endpoint-Load-Metrics. The reported
7761 # metrics to use for computing the weights are specified via thecustomMetrics field.
7762 #
7763 # This field is applicable to either:
7764 # - A regional backend service with the service protocol set to HTTP,
7765 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7766 # INTERNAL_MANAGED.
7767 # - A global backend service with the
7768 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
7769 # EXTERNAL_MANAGED.
7770 #
7771 #
7772 # If sessionAffinity is not configured—that is, if session
7773 # affinity remains at the default value of NONE—then the
7774 # default value for localityLbPolicy
7775 # is ROUND_ROBIN. If session affinity is set to a value other
7776 # than NONE,
7777 # then the default value for localityLbPolicy isMAGLEV.
7778 #
7779 # Only ROUND_ROBIN and RING_HASH are supported
7780 # when the backend service is referenced by a URL map that is bound to
7781 # target gRPC proxy that has validateForProxyless field set to true.
7782 #
7783 # localityLbPolicy cannot be specified with haPolicy.
7784 &quot;logConfig&quot;: { # The available logging options for the load balancer traffic served by this # This field denotes the logging options for the load balancer traffic served
7785 # by this backend service. If logging is enabled, logs will be exported to
7786 # Stackdriver.
7787 # backend service.
7788 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
7789 # traffic served by this backend service. The default value is false.
7790 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
7791 { # Determines which HTTP headers will be logged to Stackdriver.
7792 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7793 },
7794 ],
7795 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
7796 { # Determines which HTTP headers will be logged to Stackdriver.
7797 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7798 },
7799 ],
7800 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
7801 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
7802 # of optional fields you want to include in the logs. For example:
7803 # serverInstance, serverGkeDetails.cluster,
7804 # serverGkeDetails.pod.podNamespace
7805 &quot;A String&quot;,
7806 ],
7807 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
7808 # service. Configures whether all, none or a subset of optional fields
7809 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
7810 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
7811 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
7812 # service. The value of the field must be in [0, 1]. This configures the
7813 # sampling rate of requests to the load balancer where 1.0 means all logged
7814 # requests are reported and 0.0 means no logged requests are reported. The
7815 # default value is 1.0.
7816 },
7817 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
7818 # service. Duration is computed from the beginning of the stream until the
7819 # response has been completely processed, including all retries. A stream
7820 # that does not complete in this duration is closed.
7821 #
7822 # If not specified, there will be no timeout limit, i.e. the maximum
7823 # duration is infinite.
7824 #
7825 # This value can be overridden in the PathMatcher configuration of the
7826 # UrlMap that references this backend service.
7827 #
7828 # This field is only allowed when the loadBalancingScheme of
7829 # the backend service is INTERNAL_SELF_MANAGED.
7830 # as a count of seconds and fractions of seconds at nanosecond
7831 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7832 # or &quot;month&quot;. Range is approximately 10,000 years.
7833 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7834 # Durations less than one second are represented with a 0
7835 # `seconds` field and a positive `nanos` field. Must be from 0
7836 # to 999,999,999 inclusive.
7837 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7838 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7839 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7840 },
7841 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
7842 # controller and read by the backend RCTH
7843 &quot;a_key&quot;: &quot;A String&quot;,
7844 },
7845 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7846 # The name must be 1-63 characters long, and comply withRFC1035.
7847 # Specifically, the name must be 1-63 characters long and match the regular
7848 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7849 # character must be a lowercase letter, and all following characters must
7850 # be a dash, lowercase letter, or digit, except the last character, which
7851 # cannot be a dash.
7852 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
7853 #
7854 # This field must be set for Internal Passthrough Network Load Balancers when
7855 # the haPolicy is enabled, and for External Passthrough Network Load
7856 # Balancers when the haPolicy fastIpMove is enabled.
7857 #
7858 # This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
7859 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
7860 # Load Balancers.
7861 #
7862 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
7863 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
7864 # endpoints in the local zone.
7865 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
7866 # possible values are:
7867 #
7868 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
7869 # is disabled. The load balancer distributes new connections to all
7870 # healthy backend endpoints across all zones.
7871 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
7872 # enabled. The load balancer distributes new connections to all healthy
7873 # backend endpoints in the local zone only. If there are no healthy
7874 # backend endpoints in the local zone, the load balancer distributes
7875 # new connections to all backend endpoints in the local zone.
7876 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
7877 # enabled. The load balancer distributes new connections to all healthy
7878 # backend endpoints in the local zone only. If there aren&#x27;t enough
7879 # healthy backend endpoints in the local zone, the load balancer
7880 # distributes new connections to all healthy backend endpoints across all
7881 # zones.
7882 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
7883 # of healthy backend endpoints in a zone to the count of backend
7884 # endpoints in that same zone is equal to or above this threshold, the
7885 # load balancer distributes new connections to all healthy endpoints in
7886 # the local zone only. When the ratio of the count of healthy backend
7887 # endpoints in a zone to the count of backend endpoints in that same
7888 # zone is below this threshold, the load balancer distributes all new
7889 # connections to all healthy endpoints across all zones.
7890 },
7891 },
7892 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
7893 # the backend service.
7894 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
7895 # service.
7896 },
7897 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
7898 # load balancing pool of each individual proxy instance that processes the
7899 # traffic for the given backend service. If not set, this feature is
7900 # considered disabled.
7901 #
7902 # Results of the outlier detection algorithm (ejection of endpoints from the
7903 # load balancing pool and returning them back to the pool) are executed
7904 # independently by each proxy instance of the load balancer. In most cases,
7905 # more than one proxy instance handles the traffic received by a backend
7906 # service. Thus, it is possible that an unhealthy endpoint is detected and
7907 # ejected by only some of the proxies, and while this happens, other proxies
7908 # may continue to send requests to the same unhealthy endpoint until they
7909 # detect and eject the unhealthy endpoint.
7910 #
7911 # Applicable backend endpoints can be:
7912 #
7913 # - VM instances in an Instance Group
7914 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
7915 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
7916 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
7917 # Functions Services
7918 # - Private Service Connect NEGs, that resolve to
7919 # Google-managed regional API endpoints or managed services published using
7920 # Private Service Connect
7921 #
7922 #
7923 #
7924 # Applicable backend service types can be:
7925 #
7926 # - A global backend service with the loadBalancingScheme set to
7927 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
7928 # - A regional backend
7929 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
7930 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
7931 # supported for Serverless NEGs.
7932 #
7933 #
7934 #
7935 # Not supported when the backend service is referenced by a URL map that is
7936 # bound to target gRPC proxy that has validateForProxyless field set to true.
7937 # pool for the backend service.
7938 &quot;baseEjectionTime&quot;: { # A Duration represents a fixed-length span of time represented # The base time that a backend endpoint is ejected for. Defaults to 30000ms
7939 # or 30s.
7940 #
7941 # After a backend endpoint is returned back to the load balancing pool, it
7942 # can be ejected again in another ejection analysis. Thus, the total ejection
7943 # time is equal to the base ejection time multiplied by the number of times
7944 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
7945 # as a count of seconds and fractions of seconds at nanosecond
7946 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7947 # or &quot;month&quot;. Range is approximately 10,000 years.
7948 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7949 # Durations less than one second are represented with a 0
7950 # `seconds` field and a positive `nanos` field. Must be from 0
7951 # to 999,999,999 inclusive.
7952 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7953 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7954 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7955 },
7956 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
7957 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
7958 # return code qualifies as an error. Defaults to 5.
7959 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
7960 # connection errors that are mapped to one of those status codes) before a
7961 # consecutive gateway failure ejection occurs. Defaults to 3.
7962 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7963 # outlier status is detected through consecutive 5xx. This setting can be
7964 # used to disable ejection or to ramp it up slowly. Defaults to 0.
7965 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7966 # outlier status is detected through consecutive gateway failures. This
7967 # setting can be used to disable ejection or to ramp it up slowly. Defaults
7968 # to 100.
7969 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7970 # outlier status is detected through success rate statistics. This setting
7971 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
7972 #
7973 # Not supported when the backend service uses Serverless NEG.
7974 &quot;interval&quot;: { # A Duration represents a fixed-length span of time represented # Time interval between ejection analysis sweeps. This can result in both new
7975 # ejections and backend endpoints being returned to service. The interval is
7976 # equal to the number of seconds as defined in
7977 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
7978 # in outlierDetection.interval.nanos. Defaults to 1 second.
7979 # as a count of seconds and fractions of seconds at nanosecond
7980 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7981 # or &quot;month&quot;. Range is approximately 10,000 years.
7982 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7983 # Durations less than one second are represented with a 0
7984 # `seconds` field and a positive `nanos` field. Must be from 0
7985 # to 999,999,999 inclusive.
7986 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7987 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7988 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7989 },
7990 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
7991 # backend service that can be ejected if the ejection conditions are met.
7992 # Defaults to 50%.
7993 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
7994 # enough request volume to detect success rate outliers. If the number of
7995 # backend endpoints is fewer than this setting, outlier detection via success
7996 # rate statistics is not performed for any backend endpoint in the load
7997 # balancing pool. Defaults to 5.
7998 #
7999 # Not supported when the backend service uses Serverless NEG.
8000 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
8001 # (as defined by the interval duration above) to include this backend
8002 # endpoint in success rate based outlier detection. If the volume is lower
8003 # than this setting, outlier detection via success rate statistics is not
8004 # performed for that backend endpoint. Defaults to 100.
8005 #
8006 # Not supported when the backend service uses Serverless NEG.
8007 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
8008 # outlier ejection. The ejection threshold is the difference between the mean
8009 # success rate, and the product of this factor and the standard deviation of
8010 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
8011 # is divided by a thousand to get a double. That is, if the desired factor
8012 # is 1.9, the runtime value should be 1900. Defaults to 1900.
8013 #
8014 # Not supported when the backend service uses Serverless NEG.
8015 },
8016 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
8017 # as part of resource payload.
8018 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
8019 # Tag keys and values have the same definition as resource
8020 # manager tags. The field is allowed for INSERT
8021 # only. The keys/values to set on the resource should be specified in
8022 # either ID { : } or Namespaced format
8023 # { : }.
8024 # For example the following are valid inputs:
8025 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8026 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8027 # Note:
8028 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8029 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8030 &quot;a_key&quot;: &quot;A String&quot;,
8031 },
8032 },
8033 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
8034 # the backend. The default value is 80.
8035 # For internal passthrough Network Load Balancers and external passthrough
8036 # Network Load Balancers, omit port.
8037 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
8038 # communication to the backend VMs in that group. The
8039 # named port must be [defined on each backend instance
8040 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
8041 # This parameter has no meaning if the backends are NEGs. For internal
8042 # passthrough Network Load Balancers and external passthrough Network Load
8043 # Balancers, omit port_name.
8044 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
8045 # with backends.
8046 #
8047 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
8048 # depending on the chosen load balancer or Traffic Director configuration.
8049 # Refer to the documentation for the load balancers or for Traffic Director
8050 # for more information.
8051 #
8052 # Must be set to GRPC when the backend service is referenced by a URL map
8053 # that is bound to target gRPC proxy.
8054 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
8055 # resides. This field is not applicable to global backend services.
8056 # You must specify this field as part of the HTTP request URL. It is
8057 # not settable as a field in the request body.
8058 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
8059 # backend service.
8060 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
8061 # service. This field is applicable to a global backend service with the
8062 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
8063 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
8064 &quot;awsV4Authentication&quot;: { # Contains the configurations necessary to generate a signature for access to # The configuration needed to generate a signature for access to private
8065 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
8066 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
8067 # private storage buckets that support Signature Version 4 for authentication.
8068 # The service name for generating the authentication header will always default
8069 # to &#x27;s3&#x27;.
8070 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
8071 # creating a backend that uses AWS v4 signature authentication, but will not
8072 # be returned as part of the configuration when queried with a REST API GET
8073 # request.
8074 #
8075 # @InputOnly
8076 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
8077 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
8078 # keep track of different iterations of your access key.
8079 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
8080 # the name of the region your cloud uses to host your origin. For example,
8081 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
8082 },
8083 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
8084 # that describes how clients should authenticate with this service&#x27;s
8085 # backends.
8086 #
8087 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
8088 # to INTERNAL_SELF_MANAGED.
8089 #
8090 # If left blank, communications are not encrypted.
8091 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
8092 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
8093 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
8094 # specified values, the communication continues. Otherwise, it fails. This
8095 # additional check enables the client to verify that the server is authorized
8096 # to run the requested service.
8097 #
8098 # Note that the contents of the server
8099 # certificate&#x27;s subjectAltName field are configured by the
8100 # Public Key Infrastructure which provisions server identities.
8101 #
8102 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
8103 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
8104 # mode).
8105 &quot;A String&quot;,
8106 ],
8107 },
8108 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8109 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
8110 #
8111 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
8112 # If set, lists of backends and health checks must be both empty.
8113 &quot;A String&quot;,
8114 ],
8115 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
8116 #
8117 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
8118 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
8119 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
8120 #
8121 # Only NONE and HEADER_FIELD are supported
8122 # when the backend service is referenced by a URL map that is bound to
8123 # target gRPC proxy that has validateForProxyless field set to true.
8124 #
8125 # For more details, see:
8126 # [Session
8127 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
8128 #
8129 # sessionAffinity cannot be specified with haPolicy.
8130 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
8131 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
8132 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8133 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8134 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8135 # as a count of seconds and fractions of seconds at nanosecond
8136 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8137 # or &quot;month&quot;. Range is approximately 10,000 years.
8138 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8139 # Durations less than one second are represented with a 0
8140 # `seconds` field and a positive `nanos` field. Must be from 0
8141 # to 999,999,999 inclusive.
8142 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8143 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8144 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8145 },
8146 },
8147 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
8148 # Currently this is applicable only for Internal TCP/UDP load balancing,
8149 # Internal HTTP(S) load balancing and Traffic Director.
8150 &quot;policy&quot;: &quot;A String&quot;,
8151 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
8152 # each service mesh client.
8153 #
8154 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
8155 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
8156 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
8157 # `INTERNAL_SELF_MANAGED`.
8158 #
8159 # `subset_size` is optional for Internal HTTP(S) load balancing
8160 # and required for Traffic Director.
8161 #
8162 # If you do not provide this value, Cloud Load Balancing will calculate it
8163 # dynamically to optimize the number of proxies/clients visible to each
8164 # backend and vice versa.
8165 #
8166 # Must be greater than 0. If `subset_size` is larger than the number of
8167 # backends/endpoints, then subsetting is disabled.
8168 },
8169 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
8170 # type of load balancer. For more information see,
8171 # Backend service settings.
8172 # The default is 30 seconds.
8173 # The full range of timeout values allowed goes from 1
8174 # through 2,147,483,647 seconds.
8175 #
8176 # This value can be overridden in the PathMatcher configuration of the
8177 # UrlMap that references this backend service.
8178 #
8179 # Not supported when the backend service is referenced by a URL map that is
8180 # bound to target gRPC proxy that has validateForProxyless field set to true.
8181 # Instead, use maxStreamDuration.
8182 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
8183 # when the backend protocol is SSL, HTTPS or HTTP2.
8184 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
8185 # networksecurity.googleapis.com namespace. Can be used in authenticating
8186 # TLS connections to the backend, as specified by the authenticationMode
8187 # field. Can only be specified if authenticationMode is not NONE.
8188 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
8189 #
8190 #
8191 # Use this property to configure the load balancer back-end to use
8192 # certificates and roots of trust provisioned by the Managed Workload
8193 # Identity system.
8194 #
8195 # The `identity` property is the
8196 # fully-specified SPIFFE ID to use in the SVID presented by the Load
8197 # Balancer Workload.
8198 #
8199 # The SPIFFE ID must be a resource starting with the
8200 # `trustDomain` property value, followed by the path to the Managed
8201 # Workload Identity.
8202 #
8203 # Supported SPIFFE ID format:
8204 #
8205 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
8206 #
8207 #
8208 # The Trust Domain within the Managed Identity must refer to a valid
8209 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
8210 # will be inherited from the Workload Identity Pool.
8211 #
8212 # Restrictions:
8213 #
8214 # - If you set the `identity` property, you cannot manually set
8215 # the following fields:
8216 # - tlsSettings.sni
8217 # - tlsSettings.subjectAltNames
8218 # - tlsSettings.authenticationConfig
8219 #
8220 #
8221 # When defining a `identity` for a RegionBackendServices, the
8222 # corresponding Workload Identity Pool must have a ca_pool
8223 # configured in the same region.
8224 #
8225 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
8226 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
8227 # balancer sends this string as the SNI hostname in the TLS connection to
8228 # the backend, and requires that this string match a Subject Alternative
8229 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
8230 # NEG backend, if the SNI is specified here, the load balancer uses it
8231 # regardless of whether the Regional Internet NEG is specified with FQDN or
8232 # IP address and port. When both sni and subjectAltNames[] are specified,
8233 # the load balancer matches the backend certificate&#x27;s SAN only to
8234 # subjectAltNames[].
8235 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
8236 # verifies during a TLS handshake with the backend. When the server
8237 # presents its X.509 certificate to the Load Balancer, the Load Balancer
8238 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
8239 # match one of the subjectAltNames in the list. This field is limited to 5
8240 # entries. When both sni and subjectAltNames[] are specified, the load
8241 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
8242 { # A Subject Alternative Name that the load balancer matches against the SAN
8243 # field in the TLS certificate provided by the backend, specified as either
8244 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
8245 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
8246 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
8247 },
8248 ],
8249 },
8250 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
8251 {
8252 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
8253 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
8254 # and ForwardingRule.
8255 },
8256 ],
8257 }
8258
8259 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8260 that if you must retry your request, the server will know to ignore the
8261 request if it has already been completed.
8262
8263 For example, consider a situation where you make an initial request and
8264 the request times out. If you make the request again with the same
8265 request ID, the server can check if original operation with the same
8266 request ID was received, and if so, will ignore the second request. This
8267 prevents clients from accidentally creating duplicate commitments.
8268
8269 The request ID must be
8270 a valid UUID with the exception that zero UUID is not supported
8271 (00000000-0000-0000-0000-000000000000).
8272 x__xgafv: string, V1 error format.
8273 Allowed values
8274 1 - v1 error format
8275 2 - v2 error format
8276
8277 Returns:
8278 An object of the form:
8279
8280 { # Represents an Operation resource.
8281 #
8282 # Google Compute Engine has three Operation resources:
8283 #
8284 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
8285 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
8286 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
8287 #
8288 # You can use an operation resource to manage asynchronous API requests.
8289 # For more information, readHandling
8290 # API responses.
8291 #
8292 # Operations can be global, regional or zonal.
8293 #
8294 # - For global operations, use the `globalOperations`
8295 # resource.
8296 # - For regional operations, use the
8297 # `regionOperations` resource.
8298 # - For zonal operations, use
8299 # the `zoneOperations` resource.
8300 #
8301 #
8302 #
8303 # For more information, read
8304 # Global, Regional, and Zonal Resources.
8305 #
8306 # Note that completed Operation resources have a limited
8307 # retention period.
8308 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8309 # Not present otherwise.
8310 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8311 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8312 # set when the operation is created.
8313 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8314 # text format.
8315 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8316 # this field will be populated.
8317 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8318 # operation.
8319 {
8320 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8321 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8322 # details. There is a set of defined message types to use for providing
8323 # details.The syntax depends on the error code. For example,
8324 # QuotaExceededInfo will have details when the error code is
8325 # QUOTA_EXCEEDED.
8326 {
8327 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8328 #
8329 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8330 # is not enabled:
8331 #
8332 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8333 # &quot;domain&quot;: &quot;googleapis.com&quot;
8334 # &quot;metadata&quot;: {
8335 # &quot;resource&quot;: &quot;projects/123&quot;,
8336 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8337 # }
8338 # }
8339 #
8340 # This response indicates that the pubsub.googleapis.com API is not enabled.
8341 #
8342 # Example of an error that is returned when attempting to create a Spanner
8343 # instance in a region that is out of stock:
8344 #
8345 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8346 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8347 # &quot;metadata&quot;: {
8348 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8349 # }
8350 # }
8351 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8352 # is typically the registered service name of the tool or product that
8353 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8354 # generated by some common infrastructure, the error domain must be a
8355 # globally unique value that identifies the infrastructure. For Google API
8356 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8357 &quot;metadatas&quot;: { # Additional structured details about this error.
8358 #
8359 # Keys must match a regular expression of `a-z+` but should
8360 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8361 # length. When identifying the current value of an exceeded limit, the units
8362 # should be contained in the key, not the value. For example, rather than
8363 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8364 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8365 # instances that can be created in a single (batch) request.
8366 &quot;a_key&quot;: &quot;A String&quot;,
8367 },
8368 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8369 # proximate cause of the error. Error reasons are unique within a particular
8370 # domain of errors. This should be at most 63 characters and match a
8371 # regular expression of `A-Z+[A-Z0-9]`, which represents
8372 # UPPER_SNAKE_CASE.
8373 },
8374 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8375 #
8376 # For example, if a quota check failed with an error indicating the calling
8377 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8378 # directly to the right place in the developer console to flip the bit.
8379 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8380 { # Describes a URL link.
8381 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8382 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8383 },
8384 ],
8385 },
8386 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8387 # which can be attached to an RPC error.
8388 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8389 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8390 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8391 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8392 },
8393 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8394 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8395 &quot;a_key&quot;: &quot;A String&quot;,
8396 },
8397 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8398 # type or metric.
8399 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8400 # or metric.
8401 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8402 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8403 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8404 },
8405 },
8406 ],
8407 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8408 # This property is optional.
8409 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8410 },
8411 ],
8412 },
8413 &quot;getVersionOperationMetadata&quot;: {
8414 &quot;inlineSbomInfo&quot;: {
8415 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8416 # appropriate identifiers.
8417 &quot;a_key&quot;: &quot;A String&quot;,
8418 },
8419 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8420 # identifiers.
8421 &quot;a_key&quot;: &quot;A String&quot;,
8422 },
8423 },
8424 },
8425 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8426 # message that was returned, such as `NOT FOUND`.
8427 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8428 # status code that was returned. For example, a `404` means the
8429 # resource was not found.
8430 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8431 # defined by the server.
8432 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8433 # This value is inRFC3339
8434 # text format.
8435 &quot;instancesBulkInsertOperationMetadata&quot;: {
8436 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8437 # Example key: zones/us-central1-a
8438 &quot;a_key&quot;: {
8439 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8440 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8441 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8442 # error.
8443 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8444 # if the flow is rolling forward or rolling back.
8445 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8446 },
8447 },
8448 },
8449 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8450 # Operation resources.
8451 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8452 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8453 # group of operations results from a `bulkInsert` API request.
8454 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8455 # `update`, or `delete`, and so on.
8456 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8457 # There is no requirement that this be linear or support any granularity of
8458 # operations. This should not be used to guess when the operation will be
8459 # complete. This number should monotonically increase as the operation
8460 # progresses.
8461 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8462 # applicable when performing regional operations.
8463 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8464 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8465 # this field will contain information on all underlying zonal actions and
8466 # their state.
8467 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8468 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8469 # Example key: zones/us-central1-a
8470 &quot;a_key&quot;: {
8471 &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
8472 # populated.
8473 # different programming environments, including REST APIs and RPC APIs. It is
8474 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8475 # three pieces of data: error code, error message, and error details.
8476 #
8477 # You can find out more about this error model and how to work with it in the
8478 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8479 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8480 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8481 # message types for APIs to use.
8482 {
8483 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8484 },
8485 ],
8486 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8487 # user-facing error message should be localized and sent in the
8488 # google.rpc.Status.details field, or localized by the client.
8489 },
8490 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8491 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8492 },
8493 },
8494 },
8495 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8496 # This value is inRFC3339
8497 # text format.
8498 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8499 # following:
8500 # `PENDING`, `RUNNING`, or `DONE`.
8501 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8502 # operation.
8503 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8504 # of the target resource.
8505 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8506 # operations related to creating a snapshot, this points to the disk
8507 # that the snapshot was created from.
8508 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8509 # `[email protected]` or
8510 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8511 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8512 # operation, this field will be populated.
8513 {
8514 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8515 # Engine returns NO_RESULTS_ON_PAGE if there
8516 # are no results in the response.
8517 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8518 # value format. For example:
8519 #
8520 # &quot;data&quot;: [
8521 # {
8522 # &quot;key&quot;: &quot;scope&quot;,
8523 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8524 # }
8525 {
8526 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8527 # returned. For example, for warnings where there are no results in a list
8528 # request for a particular zone, this key might be scope and
8529 # the key value might be the zone name. Other examples might be a key
8530 # indicating a deprecated resource and a suggested replacement, or a
8531 # warning about invalid network settings (for example, if an instance
8532 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8533 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8534 },
8535 ],
8536 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8537 },
8538 ],
8539 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8540 # applicable when performing per-zone operations.
8541 }</pre>
8542 </div>
8543
8544 <div class="method">
8545 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
8546 <pre>Sets the access control policy on the specified resource.
8547 Replaces any existing policy.
8548
8549 Args:
8550 project: string, Project ID for this request. (required)
8551 region: string, The name of the region for this request. (required)
8552 resource: string, Name or id of the resource for this request. (required)
8553 body: object, The request body.
8554 The object takes the form of:
8555
8556 {
8557 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
8558 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
8559 { # Associates `members`, or principals, with a `role`.
8560 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8561 #
8562 # If the condition evaluates to `true`, then this binding applies to the
8563 # current request.
8564 #
8565 # If the condition evaluates to `false`, then this binding does not apply to
8566 # the current request. However, a different role binding might grant the same
8567 # role to one or more of the principals in this binding.
8568 #
8569 # To learn which resources support conditions in their IAM policies, see the
8570 # [IAM
8571 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8572 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8573 # are documented at https://github.com/google/cel-spec.
8574 #
8575 # Example (Comparison):
8576 #
8577 # title: &quot;Summary size limit&quot;
8578 # description: &quot;Determines if a summary is less than 100 chars&quot;
8579 # expression: &quot;document.summary.size() &lt; 100&quot;
8580 #
8581 # Example (Equality):
8582 #
8583 # title: &quot;Requestor is owner&quot;
8584 # description: &quot;Determines if requestor is the document owner&quot;
8585 # expression: &quot;document.owner == request.auth.claims.email&quot;
8586 #
8587 # Example (Logic):
8588 #
8589 # title: &quot;Public documents&quot;
8590 # description: &quot;Determine whether the document should be publicly visible&quot;
8591 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8592 #
8593 # Example (Data Manipulation):
8594 #
8595 # title: &quot;Notification string&quot;
8596 # description: &quot;Create a notification string with a timestamp.&quot;
8597 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8598 #
8599 # The exact variables and functions that may be referenced within an expression
8600 # are determined by the service that evaluates it. See the service
8601 # documentation for additional information.
8602 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8603 # describes the expression, e.g. when hovered over it in a UI.
8604 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8605 # syntax.
8606 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8607 # reporting, e.g. a file name and a position in the file.
8608 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8609 # its purpose. This can be used e.g. in UIs which allow to enter the
8610 # expression.
8611 },
8612 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8613 # `members` can have the following values:
8614 #
8615 # * `allUsers`: A special identifier that represents anyone who is
8616 # on the internet; with or without a Google account.
8617 #
8618 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8619 # who is authenticated with a Google account or a service account.
8620 # Does not include identities that come from external identity providers
8621 # (IdPs) through identity federation.
8622 #
8623 # * `user:{emailid}`: An email address that represents a specific Google
8624 # account. For example, `[email protected]` .
8625 #
8626 #
8627 # * `serviceAccount:{emailid}`: An email address that represents a Google
8628 # service account. For example,
8629 # `[email protected]`.
8630 #
8631 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8632 # identifier for a
8633 # [Kubernetes service
8634 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8635 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8636 #
8637 # * `group:{emailid}`: An email address that represents a Google group.
8638 # For example, `[email protected]`.
8639 #
8640 #
8641 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8642 # users of that domain. For example, `google.com` or `example.com`.
8643 #
8644 #
8645 #
8646 #
8647 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8648 # A single identity in a workforce identity pool.
8649 #
8650 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8651 # All workforce identities in a group.
8652 #
8653 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8654 # All workforce identities with a specific attribute value.
8655 #
8656 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8657 # All identities in a workforce identity pool.
8658 #
8659 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8660 # A single identity in a workload identity pool.
8661 #
8662 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8663 # A workload identity pool group.
8664 #
8665 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8666 # All identities in a workload identity pool with a certain attribute.
8667 #
8668 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8669 # All identities in a workload identity pool.
8670 #
8671 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8672 # identifier) representing a user that has been recently deleted. For
8673 # example, `[email protected]?uid=123456789012345678901`. If the user is
8674 # recovered, this value reverts to `user:{emailid}` and the recovered user
8675 # retains the role in the binding.
8676 #
8677 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8678 # unique identifier) representing a service account that has been recently
8679 # deleted. For example,
8680 # `[email protected]?uid=123456789012345678901`.
8681 # If the service account is undeleted, this value reverts to
8682 # `serviceAccount:{emailid}` and the undeleted service account retains the
8683 # role in the binding.
8684 #
8685 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8686 # identifier) representing a Google group that has been recently
8687 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8688 # the group is recovered, this value reverts to `group:{emailid}` and the
8689 # recovered group retains the role in the binding.
8690 #
8691 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8692 # Deleted single identity in a workforce identity pool. For example,
8693 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8694 &quot;A String&quot;,
8695 ],
8696 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8697 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8698 #
8699 # For an overview of the IAM roles and permissions, see the
8700 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8701 # a list of the available pre-defined roles, see
8702 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8703 },
8704 ],
8705 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
8706 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
8707 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
8708 # the policy is limited to a few 10s of KB. An empty policy is in general a
8709 # valid policy but certain services (like Projects) might reject them.
8710 # controls for Google Cloud resources.
8711 #
8712 #
8713 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8714 # `members`, or principals, to a single `role`. Principals can be user
8715 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8716 # `role` is a named list of permissions; each `role` can be an IAM predefined
8717 # role or a user-created custom role.
8718 #
8719 # For some types of Google Cloud resources, a `binding` can also specify a
8720 # `condition`, which is a logical expression that allows access to a resource
8721 # only if the expression evaluates to `true`. A condition can add constraints
8722 # based on attributes of the request, the resource, or both. To learn which
8723 # resources support conditions in their IAM policies, see the
8724 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8725 #
8726 # **JSON example:**
8727 #
8728 # ```
8729 # {
8730 # &quot;bindings&quot;: [
8731 # {
8732 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8733 # &quot;members&quot;: [
8734 # &quot;user:[email protected]&quot;,
8735 # &quot;group:[email protected]&quot;,
8736 # &quot;domain:google.com&quot;,
8737 # &quot;serviceAccount:[email protected]&quot;
8738 # ]
8739 # },
8740 # {
8741 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8742 # &quot;members&quot;: [
8743 # &quot;user:[email protected]&quot;
8744 # ],
8745 # &quot;condition&quot;: {
8746 # &quot;title&quot;: &quot;expirable access&quot;,
8747 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8748 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8749 # }
8750 # }
8751 # ],
8752 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8753 # &quot;version&quot;: 3
8754 # }
8755 # ```
8756 #
8757 # **YAML example:**
8758 #
8759 # ```
8760 # bindings:
8761 # - members:
8762 # - user:[email protected]
8763 # - group:[email protected]
8764 # - domain:google.com
8765 # - serviceAccount:[email protected]
8766 # role: roles/resourcemanager.organizationAdmin
8767 # - members:
8768 # - user:[email protected]
8769 # role: roles/resourcemanager.organizationViewer
8770 # condition:
8771 # title: expirable access
8772 # description: Does not grant access after Sep 2020
8773 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8774 # etag: BwWWja0YfJA=
8775 # version: 3
8776 # ```
8777 #
8778 # For a description of IAM and its features, see the
8779 # [IAM documentation](https://cloud.google.com/iam/docs/).
8780 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8781 { # Specifies the audit configuration for a service.
8782 # The configuration determines which permission types are logged, and what
8783 # identities, if any, are exempted from logging.
8784 # An AuditConfig must have one or more AuditLogConfigs.
8785 #
8786 # If there are AuditConfigs for both `allServices` and a specific service,
8787 # the union of the two AuditConfigs is used for that service: the log_types
8788 # specified in each AuditConfig are enabled, and the exempted_members in each
8789 # AuditLogConfig are exempted.
8790 #
8791 # Example Policy with multiple AuditConfigs:
8792 #
8793 # {
8794 # &quot;audit_configs&quot;: [
8795 # {
8796 # &quot;service&quot;: &quot;allServices&quot;,
8797 # &quot;audit_log_configs&quot;: [
8798 # {
8799 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8800 # &quot;exempted_members&quot;: [
8801 # &quot;user:[email protected]&quot;
8802 # ]
8803 # },
8804 # {
8805 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8806 # },
8807 # {
8808 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8809 # }
8810 # ]
8811 # },
8812 # {
8813 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8814 # &quot;audit_log_configs&quot;: [
8815 # {
8816 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8817 # },
8818 # {
8819 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8820 # &quot;exempted_members&quot;: [
8821 # &quot;user:[email protected]&quot;
8822 # ]
8823 # }
8824 # ]
8825 # }
8826 # ]
8827 # }
8828 #
8829 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8830 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8831 # `[email protected]` from DATA_WRITE logging.
8832 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8833 { # Provides the configuration for logging a type of permissions.
8834 # Example:
8835 #
8836 # {
8837 # &quot;audit_log_configs&quot;: [
8838 # {
8839 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8840 # &quot;exempted_members&quot;: [
8841 # &quot;user:[email protected]&quot;
8842 # ]
8843 # },
8844 # {
8845 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8846 # }
8847 # ]
8848 # }
8849 #
8850 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8851 # [email protected] from DATA_READ logging.
8852 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8853 # permission.
8854 # Follows the same format of Binding.members.
8855 &quot;A String&quot;,
8856 ],
8857 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8858 },
8859 ],
8860 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8861 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8862 # `allServices` is a special value that covers all services.
8863 },
8864 ],
8865 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8866 # may specify a `condition` that determines how and when the `bindings` are
8867 # applied. Each of the `bindings` must contain at least one principal.
8868 #
8869 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8870 # of these principals can be Google groups. Each occurrence of a principal
8871 # counts towards these limits. For example, if the `bindings` grant 50
8872 # different roles to `user:[email protected]`, and not to any other
8873 # principal, then you can add another 1,450 principals to the `bindings` in
8874 # the `Policy`.
8875 { # Associates `members`, or principals, with a `role`.
8876 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8877 #
8878 # If the condition evaluates to `true`, then this binding applies to the
8879 # current request.
8880 #
8881 # If the condition evaluates to `false`, then this binding does not apply to
8882 # the current request. However, a different role binding might grant the same
8883 # role to one or more of the principals in this binding.
8884 #
8885 # To learn which resources support conditions in their IAM policies, see the
8886 # [IAM
8887 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8888 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8889 # are documented at https://github.com/google/cel-spec.
8890 #
8891 # Example (Comparison):
8892 #
8893 # title: &quot;Summary size limit&quot;
8894 # description: &quot;Determines if a summary is less than 100 chars&quot;
8895 # expression: &quot;document.summary.size() &lt; 100&quot;
8896 #
8897 # Example (Equality):
8898 #
8899 # title: &quot;Requestor is owner&quot;
8900 # description: &quot;Determines if requestor is the document owner&quot;
8901 # expression: &quot;document.owner == request.auth.claims.email&quot;
8902 #
8903 # Example (Logic):
8904 #
8905 # title: &quot;Public documents&quot;
8906 # description: &quot;Determine whether the document should be publicly visible&quot;
8907 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8908 #
8909 # Example (Data Manipulation):
8910 #
8911 # title: &quot;Notification string&quot;
8912 # description: &quot;Create a notification string with a timestamp.&quot;
8913 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8914 #
8915 # The exact variables and functions that may be referenced within an expression
8916 # are determined by the service that evaluates it. See the service
8917 # documentation for additional information.
8918 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8919 # describes the expression, e.g. when hovered over it in a UI.
8920 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8921 # syntax.
8922 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8923 # reporting, e.g. a file name and a position in the file.
8924 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8925 # its purpose. This can be used e.g. in UIs which allow to enter the
8926 # expression.
8927 },
8928 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8929 # `members` can have the following values:
8930 #
8931 # * `allUsers`: A special identifier that represents anyone who is
8932 # on the internet; with or without a Google account.
8933 #
8934 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8935 # who is authenticated with a Google account or a service account.
8936 # Does not include identities that come from external identity providers
8937 # (IdPs) through identity federation.
8938 #
8939 # * `user:{emailid}`: An email address that represents a specific Google
8940 # account. For example, `[email protected]` .
8941 #
8942 #
8943 # * `serviceAccount:{emailid}`: An email address that represents a Google
8944 # service account. For example,
8945 # `[email protected]`.
8946 #
8947 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8948 # identifier for a
8949 # [Kubernetes service
8950 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8951 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8952 #
8953 # * `group:{emailid}`: An email address that represents a Google group.
8954 # For example, `[email protected]`.
8955 #
8956 #
8957 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8958 # users of that domain. For example, `google.com` or `example.com`.
8959 #
8960 #
8961 #
8962 #
8963 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8964 # A single identity in a workforce identity pool.
8965 #
8966 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8967 # All workforce identities in a group.
8968 #
8969 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8970 # All workforce identities with a specific attribute value.
8971 #
8972 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8973 # All identities in a workforce identity pool.
8974 #
8975 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8976 # A single identity in a workload identity pool.
8977 #
8978 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8979 # A workload identity pool group.
8980 #
8981 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8982 # All identities in a workload identity pool with a certain attribute.
8983 #
8984 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8985 # All identities in a workload identity pool.
8986 #
8987 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8988 # identifier) representing a user that has been recently deleted. For
8989 # example, `[email protected]?uid=123456789012345678901`. If the user is
8990 # recovered, this value reverts to `user:{emailid}` and the recovered user
8991 # retains the role in the binding.
8992 #
8993 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8994 # unique identifier) representing a service account that has been recently
8995 # deleted. For example,
8996 # `[email protected]?uid=123456789012345678901`.
8997 # If the service account is undeleted, this value reverts to
8998 # `serviceAccount:{emailid}` and the undeleted service account retains the
8999 # role in the binding.
9000 #
9001 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
9002 # identifier) representing a Google group that has been recently
9003 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
9004 # the group is recovered, this value reverts to `group:{emailid}` and the
9005 # recovered group retains the role in the binding.
9006 #
9007 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9008 # Deleted single identity in a workforce identity pool. For example,
9009 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
9010 &quot;A String&quot;,
9011 ],
9012 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
9013 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
9014 #
9015 # For an overview of the IAM roles and permissions, see the
9016 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
9017 # a list of the available pre-defined roles, see
9018 # [here](https://cloud.google.com/iam/docs/understanding-roles).
9019 },
9020 ],
9021 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
9022 # prevent simultaneous updates of a policy from overwriting each other.
9023 # It is strongly suggested that systems make use of the `etag` in the
9024 # read-modify-write cycle to perform policy updates in order to avoid race
9025 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
9026 # systems are expected to put that etag in the request to `setIamPolicy` to
9027 # ensure that their change will be applied to the same version of the policy.
9028 #
9029 # **Important:** If you use IAM Conditions, you must include the `etag` field
9030 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9031 # you to overwrite a version `3` policy with a version `1` policy, and all of
9032 # the conditions in the version `3` policy are lost.
9033 &quot;version&quot;: 42, # Specifies the format of the policy.
9034 #
9035 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
9036 # are rejected.
9037 #
9038 # Any operation that affects conditional role bindings must specify version
9039 # `3`. This requirement applies to the following operations:
9040 #
9041 # * Getting a policy that includes a conditional role binding
9042 # * Adding a conditional role binding to a policy
9043 # * Changing a conditional role binding in a policy
9044 # * Removing any role binding, with or without a condition, from a policy
9045 # that includes conditions
9046 #
9047 # **Important:** If you use IAM Conditions, you must include the `etag` field
9048 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9049 # you to overwrite a version `3` policy with a version `1` policy, and all of
9050 # the conditions in the version `3` policy are lost.
9051 #
9052 # If a policy does not include any conditions, operations on that policy may
9053 # specify any valid version or leave the field unset.
9054 #
9055 # To learn which resources support conditions in their IAM policies, see the
9056 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9057 },
9058 }
9059
9060 x__xgafv: string, V1 error format.
9061 Allowed values
9062 1 - v1 error format
9063 2 - v2 error format
9064
9065 Returns:
9066 An object of the form:
9067
9068 { # An Identity and Access Management (IAM) policy, which specifies access
9069 # controls for Google Cloud resources.
9070 #
9071 #
9072 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
9073 # `members`, or principals, to a single `role`. Principals can be user
9074 # accounts, service accounts, Google groups, and domains (such as G Suite). A
9075 # `role` is a named list of permissions; each `role` can be an IAM predefined
9076 # role or a user-created custom role.
9077 #
9078 # For some types of Google Cloud resources, a `binding` can also specify a
9079 # `condition`, which is a logical expression that allows access to a resource
9080 # only if the expression evaluates to `true`. A condition can add constraints
9081 # based on attributes of the request, the resource, or both. To learn which
9082 # resources support conditions in their IAM policies, see the
9083 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9084 #
9085 # **JSON example:**
9086 #
9087 # ```
9088 # {
9089 # &quot;bindings&quot;: [
9090 # {
9091 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
9092 # &quot;members&quot;: [
9093 # &quot;user:[email protected]&quot;,
9094 # &quot;group:[email protected]&quot;,
9095 # &quot;domain:google.com&quot;,
9096 # &quot;serviceAccount:[email protected]&quot;
9097 # ]
9098 # },
9099 # {
9100 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
9101 # &quot;members&quot;: [
9102 # &quot;user:[email protected]&quot;
9103 # ],
9104 # &quot;condition&quot;: {
9105 # &quot;title&quot;: &quot;expirable access&quot;,
9106 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
9107 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
9108 # }
9109 # }
9110 # ],
9111 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
9112 # &quot;version&quot;: 3
9113 # }
9114 # ```
9115 #
9116 # **YAML example:**
9117 #
9118 # ```
9119 # bindings:
9120 # - members:
9121 # - user:[email protected]
9122 # - group:[email protected]
9123 # - domain:google.com
9124 # - serviceAccount:[email protected]
9125 # role: roles/resourcemanager.organizationAdmin
9126 # - members:
9127 # - user:[email protected]
9128 # role: roles/resourcemanager.organizationViewer
9129 # condition:
9130 # title: expirable access
9131 # description: Does not grant access after Sep 2020
9132 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
9133 # etag: BwWWja0YfJA=
9134 # version: 3
9135 # ```
9136 #
9137 # For a description of IAM and its features, see the
9138 # [IAM documentation](https://cloud.google.com/iam/docs/).
9139 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
9140 { # Specifies the audit configuration for a service.
9141 # The configuration determines which permission types are logged, and what
9142 # identities, if any, are exempted from logging.
9143 # An AuditConfig must have one or more AuditLogConfigs.
9144 #
9145 # If there are AuditConfigs for both `allServices` and a specific service,
9146 # the union of the two AuditConfigs is used for that service: the log_types
9147 # specified in each AuditConfig are enabled, and the exempted_members in each
9148 # AuditLogConfig are exempted.
9149 #
9150 # Example Policy with multiple AuditConfigs:
9151 #
9152 # {
9153 # &quot;audit_configs&quot;: [
9154 # {
9155 # &quot;service&quot;: &quot;allServices&quot;,
9156 # &quot;audit_log_configs&quot;: [
9157 # {
9158 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9159 # &quot;exempted_members&quot;: [
9160 # &quot;user:[email protected]&quot;
9161 # ]
9162 # },
9163 # {
9164 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9165 # },
9166 # {
9167 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
9168 # }
9169 # ]
9170 # },
9171 # {
9172 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
9173 # &quot;audit_log_configs&quot;: [
9174 # {
9175 # &quot;log_type&quot;: &quot;DATA_READ&quot;
9176 # },
9177 # {
9178 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
9179 # &quot;exempted_members&quot;: [
9180 # &quot;user:[email protected]&quot;
9181 # ]
9182 # }
9183 # ]
9184 # }
9185 # ]
9186 # }
9187 #
9188 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
9189 # logging. It also exempts `[email protected]` from DATA_READ logging, and
9190 # `[email protected]` from DATA_WRITE logging.
9191 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
9192 { # Provides the configuration for logging a type of permissions.
9193 # Example:
9194 #
9195 # {
9196 # &quot;audit_log_configs&quot;: [
9197 # {
9198 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
9199 # &quot;exempted_members&quot;: [
9200 # &quot;user:[email protected]&quot;
9201 # ]
9202 # },
9203 # {
9204 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
9205 # }
9206 # ]
9207 # }
9208 #
9209 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
9210 # [email protected] from DATA_READ logging.
9211 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
9212 # permission.
9213 # Follows the same format of Binding.members.
9214 &quot;A String&quot;,
9215 ],
9216 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
9217 },
9218 ],
9219 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
9220 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
9221 # `allServices` is a special value that covers all services.
9222 },
9223 ],
9224 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
9225 # may specify a `condition` that determines how and when the `bindings` are
9226 # applied. Each of the `bindings` must contain at least one principal.
9227 #
9228 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
9229 # of these principals can be Google groups. Each occurrence of a principal
9230 # counts towards these limits. For example, if the `bindings` grant 50
9231 # different roles to `user:[email protected]`, and not to any other
9232 # principal, then you can add another 1,450 principals to the `bindings` in
9233 # the `Policy`.
9234 { # Associates `members`, or principals, with a `role`.
9235 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
9236 #
9237 # If the condition evaluates to `true`, then this binding applies to the
9238 # current request.
9239 #
9240 # If the condition evaluates to `false`, then this binding does not apply to
9241 # the current request. However, a different role binding might grant the same
9242 # role to one or more of the principals in this binding.
9243 #
9244 # To learn which resources support conditions in their IAM policies, see the
9245 # [IAM
9246 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9247 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
9248 # are documented at https://github.com/google/cel-spec.
9249 #
9250 # Example (Comparison):
9251 #
9252 # title: &quot;Summary size limit&quot;
9253 # description: &quot;Determines if a summary is less than 100 chars&quot;
9254 # expression: &quot;document.summary.size() &lt; 100&quot;
9255 #
9256 # Example (Equality):
9257 #
9258 # title: &quot;Requestor is owner&quot;
9259 # description: &quot;Determines if requestor is the document owner&quot;
9260 # expression: &quot;document.owner == request.auth.claims.email&quot;
9261 #
9262 # Example (Logic):
9263 #
9264 # title: &quot;Public documents&quot;
9265 # description: &quot;Determine whether the document should be publicly visible&quot;
9266 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
9267 #
9268 # Example (Data Manipulation):
9269 #
9270 # title: &quot;Notification string&quot;
9271 # description: &quot;Create a notification string with a timestamp.&quot;
9272 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
9273 #
9274 # The exact variables and functions that may be referenced within an expression
9275 # are determined by the service that evaluates it. See the service
9276 # documentation for additional information.
9277 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
9278 # describes the expression, e.g. when hovered over it in a UI.
9279 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
9280 # syntax.
9281 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
9282 # reporting, e.g. a file name and a position in the file.
9283 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
9284 # its purpose. This can be used e.g. in UIs which allow to enter the
9285 # expression.
9286 },
9287 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
9288 # `members` can have the following values:
9289 #
9290 # * `allUsers`: A special identifier that represents anyone who is
9291 # on the internet; with or without a Google account.
9292 #
9293 # * `allAuthenticatedUsers`: A special identifier that represents anyone
9294 # who is authenticated with a Google account or a service account.
9295 # Does not include identities that come from external identity providers
9296 # (IdPs) through identity federation.
9297 #
9298 # * `user:{emailid}`: An email address that represents a specific Google
9299 # account. For example, `[email protected]` .
9300 #
9301 #
9302 # * `serviceAccount:{emailid}`: An email address that represents a Google
9303 # service account. For example,
9304 # `[email protected]`.
9305 #
9306 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
9307 # identifier for a
9308 # [Kubernetes service
9309 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
9310 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
9311 #
9312 # * `group:{emailid}`: An email address that represents a Google group.
9313 # For example, `[email protected]`.
9314 #
9315 #
9316 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
9317 # users of that domain. For example, `google.com` or `example.com`.
9318 #
9319 #
9320 #
9321 #
9322 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9323 # A single identity in a workforce identity pool.
9324 #
9325 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
9326 # All workforce identities in a group.
9327 #
9328 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9329 # All workforce identities with a specific attribute value.
9330 #
9331 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
9332 # All identities in a workforce identity pool.
9333 #
9334 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
9335 # A single identity in a workload identity pool.
9336 #
9337 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
9338 # A workload identity pool group.
9339 #
9340 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
9341 # All identities in a workload identity pool with a certain attribute.
9342 #
9343 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
9344 # All identities in a workload identity pool.
9345 #
9346 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
9347 # identifier) representing a user that has been recently deleted. For
9348 # example, `[email protected]?uid=123456789012345678901`. If the user is
9349 # recovered, this value reverts to `user:{emailid}` and the recovered user
9350 # retains the role in the binding.
9351 #
9352 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
9353 # unique identifier) representing a service account that has been recently
9354 # deleted. For example,
9355 # `[email protected]?uid=123456789012345678901`.
9356 # If the service account is undeleted, this value reverts to
9357 # `serviceAccount:{emailid}` and the undeleted service account retains the
9358 # role in the binding.
9359 #
9360 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
9361 # identifier) representing a Google group that has been recently
9362 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
9363 # the group is recovered, this value reverts to `group:{emailid}` and the
9364 # recovered group retains the role in the binding.
9365 #
9366 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
9367 # Deleted single identity in a workforce identity pool. For example,
9368 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
9369 &quot;A String&quot;,
9370 ],
9371 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
9372 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
9373 #
9374 # For an overview of the IAM roles and permissions, see the
9375 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
9376 # a list of the available pre-defined roles, see
9377 # [here](https://cloud.google.com/iam/docs/understanding-roles).
9378 },
9379 ],
9380 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
9381 # prevent simultaneous updates of a policy from overwriting each other.
9382 # It is strongly suggested that systems make use of the `etag` in the
9383 # read-modify-write cycle to perform policy updates in order to avoid race
9384 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
9385 # systems are expected to put that etag in the request to `setIamPolicy` to
9386 # ensure that their change will be applied to the same version of the policy.
9387 #
9388 # **Important:** If you use IAM Conditions, you must include the `etag` field
9389 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9390 # you to overwrite a version `3` policy with a version `1` policy, and all of
9391 # the conditions in the version `3` policy are lost.
9392 &quot;version&quot;: 42, # Specifies the format of the policy.
9393 #
9394 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
9395 # are rejected.
9396 #
9397 # Any operation that affects conditional role bindings must specify version
9398 # `3`. This requirement applies to the following operations:
9399 #
9400 # * Getting a policy that includes a conditional role binding
9401 # * Adding a conditional role binding to a policy
9402 # * Changing a conditional role binding in a policy
9403 # * Removing any role binding, with or without a condition, from a policy
9404 # that includes conditions
9405 #
9406 # **Important:** If you use IAM Conditions, you must include the `etag` field
9407 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
9408 # you to overwrite a version `3` policy with a version `1` policy, and all of
9409 # the conditions in the version `3` policy are lost.
9410 #
9411 # If a policy does not include any conditions, operations on that policy may
9412 # specify any valid version or leave the field unset.
9413 #
9414 # To learn which resources support conditions in their IAM policies, see the
9415 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
9416 }</pre>
9417 </div>
9418
9419 <div class="method">
9420 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
9421 <pre>Sets the Google Cloud Armor security policy for the specified backend
9422 service. For more information, seeGoogle
9423 Cloud Armor Overview
9424
9425 Args:
9426 project: string, Project ID for this request. (required)
9427 region: string, Name of the region scoping this request. (required)
9428 backendService: string, Name of the BackendService resource to which the security policy should be
9429 set. The name should conform to RFC1035. (required)
9430 body: object, The request body.
9431 The object takes the form of:
9432
9433 {
9434 &quot;securityPolicy&quot;: &quot;A String&quot;,
9435 }
9436
9437 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9438 that if you must retry your request, the server will know to ignore the
9439 request if it has already been completed.
9440
9441 For example, consider a situation where you make an initial request and
9442 the request times out. If you make the request again with the same
9443 request ID, the server can check if original operation with the same
9444 request ID was received, and if so, will ignore the second request. This
9445 prevents clients from accidentally creating duplicate commitments.
9446
9447 The request ID must be
9448 a valid UUID with the exception that zero UUID is not supported
9449 (00000000-0000-0000-0000-000000000000).
9450 x__xgafv: string, V1 error format.
9451 Allowed values
9452 1 - v1 error format
9453 2 - v2 error format
9454
9455 Returns:
9456 An object of the form:
9457
9458 { # Represents an Operation resource.
9459 #
9460 # Google Compute Engine has three Operation resources:
9461 #
9462 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
9463 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
9464 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
9465 #
9466 # You can use an operation resource to manage asynchronous API requests.
9467 # For more information, readHandling
9468 # API responses.
9469 #
9470 # Operations can be global, regional or zonal.
9471 #
9472 # - For global operations, use the `globalOperations`
9473 # resource.
9474 # - For regional operations, use the
9475 # `regionOperations` resource.
9476 # - For zonal operations, use
9477 # the `zoneOperations` resource.
9478 #
9479 #
9480 #
9481 # For more information, read
9482 # Global, Regional, and Zonal Resources.
9483 #
9484 # Note that completed Operation resources have a limited
9485 # retention period.
9486 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9487 # Not present otherwise.
9488 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9489 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9490 # set when the operation is created.
9491 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9492 # text format.
9493 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9494 # this field will be populated.
9495 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9496 # operation.
9497 {
9498 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9499 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9500 # details. There is a set of defined message types to use for providing
9501 # details.The syntax depends on the error code. For example,
9502 # QuotaExceededInfo will have details when the error code is
9503 # QUOTA_EXCEEDED.
9504 {
9505 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9506 #
9507 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9508 # is not enabled:
9509 #
9510 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9511 # &quot;domain&quot;: &quot;googleapis.com&quot;
9512 # &quot;metadata&quot;: {
9513 # &quot;resource&quot;: &quot;projects/123&quot;,
9514 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9515 # }
9516 # }
9517 #
9518 # This response indicates that the pubsub.googleapis.com API is not enabled.
9519 #
9520 # Example of an error that is returned when attempting to create a Spanner
9521 # instance in a region that is out of stock:
9522 #
9523 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9524 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9525 # &quot;metadata&quot;: {
9526 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9527 # }
9528 # }
9529 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9530 # is typically the registered service name of the tool or product that
9531 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9532 # generated by some common infrastructure, the error domain must be a
9533 # globally unique value that identifies the infrastructure. For Google API
9534 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9535 &quot;metadatas&quot;: { # Additional structured details about this error.
9536 #
9537 # Keys must match a regular expression of `a-z+` but should
9538 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9539 # length. When identifying the current value of an exceeded limit, the units
9540 # should be contained in the key, not the value. For example, rather than
9541 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9542 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9543 # instances that can be created in a single (batch) request.
9544 &quot;a_key&quot;: &quot;A String&quot;,
9545 },
9546 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9547 # proximate cause of the error. Error reasons are unique within a particular
9548 # domain of errors. This should be at most 63 characters and match a
9549 # regular expression of `A-Z+[A-Z0-9]`, which represents
9550 # UPPER_SNAKE_CASE.
9551 },
9552 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9553 #
9554 # For example, if a quota check failed with an error indicating the calling
9555 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9556 # directly to the right place in the developer console to flip the bit.
9557 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9558 { # Describes a URL link.
9559 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9560 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9561 },
9562 ],
9563 },
9564 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9565 # which can be attached to an RPC error.
9566 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9567 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9568 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9569 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9570 },
9571 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9572 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9573 &quot;a_key&quot;: &quot;A String&quot;,
9574 },
9575 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9576 # type or metric.
9577 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9578 # or metric.
9579 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9580 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9581 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9582 },
9583 },
9584 ],
9585 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9586 # This property is optional.
9587 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9588 },
9589 ],
9590 },
9591 &quot;getVersionOperationMetadata&quot;: {
9592 &quot;inlineSbomInfo&quot;: {
9593 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9594 # appropriate identifiers.
9595 &quot;a_key&quot;: &quot;A String&quot;,
9596 },
9597 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9598 # identifiers.
9599 &quot;a_key&quot;: &quot;A String&quot;,
9600 },
9601 },
9602 },
9603 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9604 # message that was returned, such as `NOT FOUND`.
9605 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9606 # status code that was returned. For example, a `404` means the
9607 # resource was not found.
9608 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9609 # defined by the server.
9610 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9611 # This value is inRFC3339
9612 # text format.
9613 &quot;instancesBulkInsertOperationMetadata&quot;: {
9614 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9615 # Example key: zones/us-central1-a
9616 &quot;a_key&quot;: {
9617 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9618 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9619 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9620 # error.
9621 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9622 # if the flow is rolling forward or rolling back.
9623 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9624 },
9625 },
9626 },
9627 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9628 # Operation resources.
9629 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9630 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9631 # group of operations results from a `bulkInsert` API request.
9632 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9633 # `update`, or `delete`, and so on.
9634 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9635 # There is no requirement that this be linear or support any granularity of
9636 # operations. This should not be used to guess when the operation will be
9637 # complete. This number should monotonically increase as the operation
9638 # progresses.
9639 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9640 # applicable when performing regional operations.
9641 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9642 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9643 # this field will contain information on all underlying zonal actions and
9644 # their state.
9645 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9646 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9647 # Example key: zones/us-central1-a
9648 &quot;a_key&quot;: {
9649 &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
9650 # populated.
9651 # different programming environments, including REST APIs and RPC APIs. It is
9652 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9653 # three pieces of data: error code, error message, and error details.
9654 #
9655 # You can find out more about this error model and how to work with it in the
9656 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9657 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9658 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9659 # message types for APIs to use.
9660 {
9661 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9662 },
9663 ],
9664 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9665 # user-facing error message should be localized and sent in the
9666 # google.rpc.Status.details field, or localized by the client.
9667 },
9668 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9669 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9670 },
9671 },
9672 },
9673 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9674 # This value is inRFC3339
9675 # text format.
9676 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9677 # following:
9678 # `PENDING`, `RUNNING`, or `DONE`.
9679 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9680 # operation.
9681 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9682 # of the target resource.
9683 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9684 # operations related to creating a snapshot, this points to the disk
9685 # that the snapshot was created from.
9686 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9687 # `[email protected]` or
9688 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9689 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9690 # operation, this field will be populated.
9691 {
9692 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9693 # Engine returns NO_RESULTS_ON_PAGE if there
9694 # are no results in the response.
9695 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9696 # value format. For example:
9697 #
9698 # &quot;data&quot;: [
9699 # {
9700 # &quot;key&quot;: &quot;scope&quot;,
9701 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9702 # }
9703 {
9704 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9705 # returned. For example, for warnings where there are no results in a list
9706 # request for a particular zone, this key might be scope and
9707 # the key value might be the zone name. Other examples might be a key
9708 # indicating a deprecated resource and a suggested replacement, or a
9709 # warning about invalid network settings (for example, if an instance
9710 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9711 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9712 },
9713 ],
9714 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9715 },
9716 ],
9717 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9718 # applicable when performing per-zone operations.
9719 }</pre>
9720 </div>
9721
9722 <div class="method">
9723 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
9724 <pre>Returns permissions that a caller has on the specified resource.
9725
9726 Args:
9727 project: string, Project ID for this request. (required)
9728 region: string, The name of the region for this request. (required)
9729 resource: string, Name or id of the resource for this request. (required)
9730 body: object, The request body.
9731 The object takes the form of:
9732
9733 {
9734 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
9735 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
9736 &quot;A String&quot;,
9737 ],
9738 }
9739
9740 x__xgafv: string, V1 error format.
9741 Allowed values
9742 1 - v1 error format
9743 2 - v2 error format
9744
9745 Returns:
9746 An object of the form:
9747
9748 {
9749 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
9750 # allowed.
9751 &quot;A String&quot;,
9752 ],
9753 }</pre>
9754 </div>
9755
9756 <div class="method">
9757 <code class="details" id="update">update(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
9758 <pre>Updates the specified regional BackendService resource with the data
9759 included in the request. For more information,
9760 see
9761 Backend services overview.
9762
9763 Args:
9764 project: string, Project ID for this request. (required)
9765 region: string, Name of the region scoping this request. (required)
9766 backendService: string, Name of the BackendService resource to update. (required)
9767 body: object, The request body.
9768 The object takes the form of:
9769
9770 { # Represents a Backend Service resource.
9771 #
9772 # A backend service defines how Google Cloud load balancers distribute traffic.
9773 # The backend service configuration contains a set of values, such as the
9774 # protocol used to connect to backends, various distribution and session
9775 # settings, health checks, and timeouts. These settings provide fine-grained
9776 # control over how your load balancer behaves. Most of the settings have
9777 # default values that allow for easy configuration if you need to get started
9778 # quickly.
9779 #
9780 # Backend services in Google Compute Engine can be either regionally or
9781 # globally scoped.
9782 #
9783 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
9784 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
9785 #
9786 # For more information, seeBackend
9787 # Services.
9788 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
9789 # Load Balancers and Traffic Director and requires
9790 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
9791 #
9792 # If set to 0, the cookie is non-persistent and lasts only until
9793 # the end of the browser session (or equivalent). The maximum allowed value
9794 # is two weeks (1,209,600).
9795 #
9796 # Not supported when the backend service is referenced by a URL map that is
9797 # bound to target gRPC proxy that has validateForProxyless field set to true.
9798 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
9799 { # Message containing information of one individual backend.
9800 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
9801 # handle additional traffic or is fully loaded. For usage guidelines, see
9802 # Connection balancing mode.
9803 #
9804 # Backends must use compatible balancing modes. For more information, see
9805 # Supported balancing modes and target capacity settings and
9806 # Restrictions and guidance for instance groups.
9807 #
9808 # Note: Currently, if you use the API to configure incompatible balancing
9809 # modes, the configuration might be accepted even though it has no impact
9810 # and is ignored. Specifically, Backend.maxUtilization is ignored when
9811 # Backend.balancingMode is RATE. In the future, this incompatible combination
9812 # will be rejected.
9813 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
9814 # mode.
9815 # The default value is 1, which means the group serves up to
9816 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
9817 # completely drained, offering 0% of its available capacity. The valid ranges
9818 # are 0.0 and [0.1,1.0].
9819 # You cannot configure a setting larger than 0 and smaller than0.1.
9820 # You cannot configure a setting of 0 when there is only one
9821 # backend attached to the backend service.
9822 #
9823 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
9824 # internet NEGs, regional serverless NEGs, and PSC NEGs.
9825 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
9826 # BalancingMode.
9827 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
9828 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
9829 # Monitoring, but is not used for load balancing.
9830 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
9831 # balancing mode. The valid range is [0.0, 1.0].
9832 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
9833 # long and match the regular expression
9834 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
9835 # first character must be a lowercase letter, and all following
9836 # characters must be a dash, period, underscore, lowercase letter, or
9837 # digit, except the last character, which cannot be a dash, period, or
9838 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
9839 # field can only be used for a global or regional backend service with the
9840 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
9841 },
9842 ],
9843 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9844 # create the resource.
9845 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
9846 # failover backend can be configured for a given BackendService.
9847 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
9848 # group or network endpoint
9849 # group (NEG) resource. To determine what types of backends a load
9850 # balancer supports, see the [Backend services
9851 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
9852 #
9853 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
9854 # or NEG. Partial URLs are not supported.
9855 #
9856 # If haPolicy is specified, backends must refer to NEG resources of type
9857 # GCE_VM_IP.
9858 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
9859 # guidelines, seeConnection
9860 # balancing mode and Utilization
9861 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
9862 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
9863 # guidelines, seeConnection
9864 # balancing mode and Utilization
9865 # balancing mode.
9866 #
9867 # Not available if the backend&#x27;s balancingMode isRATE.
9868 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
9869 # For usage guidelines, seeConnection
9870 # balancing mode and Utilization
9871 # balancing mode.
9872 #
9873 # Not available if the backend&#x27;s balancingMode isRATE.
9874 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
9875 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
9876 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
9877 # Not available if backend&#x27;s balancingMode is RATE
9878 # or CONNECTION.
9879 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
9880 # Not available if backend&#x27;s balancingMode is RATE
9881 # or CONNECTION.
9882 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
9883 # usage guidelines, seeRate
9884 # balancing mode and Utilization
9885 # balancing mode.
9886 #
9887 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9888 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
9889 # guidelines, seeRate
9890 # balancing mode and Utilization
9891 # balancing mode.
9892 #
9893 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9894 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
9895 # guidelines, seeRate
9896 # balancing mode and Utilization
9897 # balancing mode.
9898 #
9899 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9900 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
9901 #
9902 # For usage guidelines, seeUtilization
9903 # balancing mode.
9904 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
9905 # the backend.
9906 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
9907 },
9908 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
9909 # sending traffic to backends with default preference. The possible values
9910 # are:
9911 #
9912 # - PREFERRED: Backends with this preference level will be
9913 # filled up to their capacity limits first, based on RTT.
9914 # - DEFAULT: If preferred backends don&#x27;t have enough
9915 # capacity, backends in this layer would be used and traffic would be
9916 # assigned based on the load balancing algorithm you use. This is the
9917 # default
9918 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
9919 # Attachment).
9920 # e.g.
9921 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
9922 # for Cloud Run service.
9923 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
9924 # for PSC Service Attachment.
9925 &quot;trafficDuration&quot;: &quot;A String&quot;,
9926 },
9927 ],
9928 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
9929 # specified load balancer types.
9930 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
9931 # Pragma or Authorization headers. Up to 5 headers can be specified.
9932 # The cache is bypassed for all cdnPolicy.cacheMode settings.
9933 { # Bypass the cache when the specified request headers are present,
9934 # e.g. Pragma or Authorization headers. Values are case insensitive.
9935 # The presence of such a header overrides the cache_mode setting.
9936 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
9937 # Values are case-insensitive.
9938 },
9939 ],
9940 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
9941 # CDN.
9942 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
9943 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
9944 &quot;A String&quot;,
9945 ],
9946 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
9947 # The name=value pair will be used in the cache key Cloud CDN generates.
9948 &quot;A String&quot;,
9949 ],
9950 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
9951 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
9952 # query_string_whitelist and query_string_blacklist. If neither is set, the
9953 # entire query string will be included. If false, the query string will be
9954 # excluded from the cache key entirely.
9955 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
9956 # parameters will be included. Either specify query_string_whitelist or
9957 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
9958 # not treated as delimiters.
9959 &quot;A String&quot;,
9960 ],
9961 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
9962 # parameters will be excluded. Either specify query_string_whitelist or
9963 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
9964 # not treated as delimiters.
9965 &quot;A String&quot;,
9966 ],
9967 },
9968 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
9969 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
9970 # headers to cache content. Responses without these headers will not be
9971 # cached at Google&#x27;s edge, and will require a full trip to the origin on
9972 # every request, potentially impacting performance and increasing load on
9973 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
9974 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
9975 # Warning: this may result in Cloud CDN caching private,
9976 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
9977 # including common image formats, media (video and audio), and web assets
9978 # (JavaScript and CSS). Requests and responses that are marked as
9979 # uncacheable, as well as dynamic content (including HTML), will not be
9980 # cached.
9981 #
9982 # If no value is provided for cdnPolicy.cacheMode, it defaults
9983 # to CACHE_ALL_STATIC.
9984 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
9985 # used to clamp the max-age (or Expires) value sent to the client. With
9986 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
9987 # response max-age directive, along with a &quot;public&quot; directive. For
9988 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
9989 # from the origin (if specified), or else sets the response max-age
9990 # directive to the lesser of the client_ttl and default_ttl, and also
9991 # ensures a &quot;public&quot; cache-control directive is present.
9992 # If a client TTL is not specified, a default value (1 hour) will be used.
9993 # The maximum allowed value is 31,622,400s (1 year).
9994 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
9995 # responses that do not have an existing valid TTL (max-age or s-maxage).
9996 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
9997 # The value of defaultTTL cannot be set to a value greater than that of
9998 # maxTTL, but can be equal.
9999 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
10000 # will overwrite the TTL set in all responses. The maximum allowed value is
10001 # 31,622,400s (1 year), noting that infrequently accessed objects may be
10002 # evicted from the cache before the defined TTL.
10003 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
10004 # origin.
10005 # Cache directives that attempt to set a max-age or s-maxage higher than
10006 # this, or an Expires header more than maxTTL seconds in the future will
10007 # be capped at the value of maxTTL, as if it were the value of an
10008 # s-maxage Cache-Control directive.
10009 # Headers sent to the client will not be modified.
10010 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
10011 # The maximum allowed value is 31,622,400s (1 year), noting that
10012 # infrequently accessed objects may be evicted from the cache before
10013 # the defined TTL.
10014 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
10015 # to apply fine-grained caching for common errors or redirects.
10016 # This can reduce the load on your origin and improve end-user
10017 # experience by reducing response latency.
10018 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
10019 # negative caching applies to responses with the specified response code
10020 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
10021 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
10022 # to all responses with the specified response code, and override any
10023 # caching headers.
10024 # By default, Cloud CDN will apply the following default TTLs to these
10025 # status codes:
10026 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
10027 # HTTP 404 (Not Found), 410 (Gone),
10028 # 451 (Unavailable For Legal Reasons): 120s
10029 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
10030 # These defaults can be overridden in negative_caching_policy.
10031 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
10032 # negative_caching must be enabled to configure negative_caching_policy.
10033 # Omitting the policy and leaving negative_caching enabled will use
10034 # Cloud CDN&#x27;s default cache TTLs.
10035 # Note that when specifying an explicit negative_caching_policy, you
10036 # should take care to specify a cache TTL for all response codes
10037 # that you wish to cache. Cloud CDN will not apply any default
10038 # negative caching when a policy exists.
10039 { # Specify CDN TTLs for response error codes.
10040 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
10041 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
10042 # specified as values, and you cannot specify a status code more than
10043 # once.
10044 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
10045 # corresponding status code.
10046 # The maximum allowed value is 1800s (30 minutes), noting that
10047 # infrequently accessed objects may be evicted from the cache before the
10048 # defined TTL.
10049 },
10050 ],
10051 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
10052 # requests into a small number of requests to the origin.
10053 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
10054 # content with the origin, or when an error is encountered when refreshing
10055 # the cache.
10056 # This setting defines the default &quot;max-stale&quot; duration for any cached
10057 # responses that do not specify a max-stale directive. Stale responses that
10058 # exceed the TTL configured here will not be served. The default limit
10059 # (max-stale) is 86400s (1 day), which will allow stale content to be
10060 # served up to this limit beyond the max-age (or s-maxage) of a cached
10061 # response.
10062 # The maximum allowed value is 604800 (1 week).
10063 # Set this to zero (0) to disable serve-while-stale.
10064 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
10065 # considered fresh. After this time period, the response will be
10066 # revalidated before being served. Defaults to 1hr (3600s). When serving
10067 # responses to signed URL requests, Cloud CDN will internally behave as
10068 # though all responses from this backend had a &quot;Cache-Control:
10069 # public, max-age=[TTL]&quot; header, regardless of any existing
10070 # Cache-Control header. The actual headers served in responses will not be
10071 # altered.
10072 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
10073 &quot;A String&quot;,
10074 ],
10075 },
10076 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
10077 # backend service.
10078 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
10079 # as a count of seconds and fractions of seconds at nanosecond
10080 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10081 # or &quot;month&quot;. Range is approximately 10,000 years.
10082 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10083 # Durations less than one second are represented with a 0
10084 # `seconds` field and a positive `nanos` field. Must be from 0
10085 # to 999,999,999 inclusive.
10086 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10087 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10088 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10089 },
10090 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
10091 # there is no limit.
10092 #
10093 # Not supported when the backend service is referenced by a URL map that is
10094 # bound to target gRPC proxy that has validateForProxyless field set to true.
10095 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
10096 # not specified, there is no limit.
10097 #
10098 # Not supported when the backend service is referenced by a URL map that is
10099 # bound to target gRPC proxy that has validateForProxyless field set to true.
10100 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
10101 # service. If not specified, there is no limit.
10102 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
10103 # This parameter is respected by both the HTTP/1.1 and HTTP/2
10104 # implementations. If not specified, there is no limit. Setting this
10105 # parameter to 1 will effectively disable keep alive.
10106 #
10107 # Not supported when the backend service is referenced by a URL map that is
10108 # bound to target gRPC proxy that has validateForProxyless field set to true.
10109 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
10110 # not specified, the default is 1.
10111 #
10112 # Not supported when the backend service is referenced by a URL map that is
10113 # bound to target gRPC proxy that has validateForProxyless field set to true.
10114 },
10115 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
10116 # the client&#x27;s Accept-Encoding header.
10117 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
10118 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
10119 # instance. For supported load balancers and protocols, as described inEnabling
10120 # connection draining.
10121 },
10122 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
10123 # tracking policy settings are only available for external passthrough
10124 # Network Load Balancers and internal passthrough Network Load Balancers.
10125 #
10126 # connectionTrackingPolicy cannot be specified with haPolicy.
10127 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
10128 # value is DEFAULT_FOR_PROTOCOL.
10129 #
10130 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
10131 # persist on unhealthy backends only for connection-oriented protocols
10132 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
10133 # Affinity is configured for 5-tuple. They do not persist forUDP.
10134 #
10135 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
10136 # the existing connections on the unhealthy backend are never persisted on
10137 # the unhealthy backend. They are always diverted to newly selected healthy
10138 # backends (unless all backends are unhealthy).
10139 #
10140 # If set to ALWAYS_PERSIST, existing connections always
10141 # persist on unhealthy backends regardless of protocol and session
10142 # affinity. It is generally not recommended to use this mode overriding the
10143 # default.
10144 #
10145 # For more details, see [Connection Persistence for Network Load
10146 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
10147 # and [Connection Persistence for Internal TCP/UDP Load
10148 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
10149 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
10150 # Balancers. This option is not available publicly.
10151 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
10152 # matching traffic (in seconds).
10153 #
10154 # For internal passthrough Network Load Balancers:
10155 #
10156 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
10157 # - It can be set only if Connection Tracking is less than 5-tuple
10158 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
10159 # Mode is PER_SESSION).
10160 #
10161 #
10162 #
10163 # For external passthrough Network Load Balancers the default is 60
10164 # seconds. This option is not available publicly.
10165 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
10166 # options:
10167 #
10168 # - PER_CONNECTION: This is the default mode. The Connection
10169 # Tracking is performed as per the Connection Key (default Hash Method) for
10170 # the specific protocol.
10171 # - PER_SESSION: The Connection Tracking is performed as per
10172 # the configured Session Affinity. It matches the configured Session
10173 # Affinity.
10174 #
10175 #
10176 #
10177 # For more details, see [Tracking Mode for Network Load
10178 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
10179 # and [Tracking Mode for Internal TCP/UDP Load
10180 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
10181 },
10182 &quot;consistentHash&quot;: { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session
10183 # affinity based on HTTP headers, cookies or other properties. This load
10184 # balancing policy is applicable only for HTTP connections. The affinity to a
10185 # particular destination host will be lost when one or more hosts are
10186 # added/removed from the destination service. This field specifies parameters
10187 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
10188 #
10189 # This field is applicable to either:
10190 #
10191 # - A regional backend service with the service protocol set to HTTP,
10192 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10193 # INTERNAL_MANAGED.
10194 # - A global backend service with the
10195 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
10196 &quot;httpCookie&quot;: { # The information about the HTTP Cookie on which the hash function is based # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
10197 # be used as the hash key for the consistent hash load balancer. If the
10198 # cookie is not present, it will be generated. This field is applicable if
10199 # the sessionAffinity is set to HTTP_COOKIE.
10200 #
10201 # Not supported when the backend service is referenced by a URL map that is
10202 # bound to target gRPC proxy that has validateForProxyless field set to true.
10203 # for load balancing policies that use a consistent hash.
10204 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
10205 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
10206 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
10207 # as a count of seconds and fractions of seconds at nanosecond
10208 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10209 # or &quot;month&quot;. Range is approximately 10,000 years.
10210 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10211 # Durations less than one second are represented with a 0
10212 # `seconds` field and a positive `nanos` field. Must be from 0
10213 # to 999,999,999 inclusive.
10214 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10215 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10216 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10217 },
10218 },
10219 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
10220 # applicable if the sessionAffinity is set toHEADER_FIELD.
10221 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
10222 # 1024. Larger ring sizes result in more granular load distributions. If the
10223 # number of hosts in the load balancing pool is larger than the ring size,
10224 # each host will be assigned a single virtual node.
10225 },
10226 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
10227 # text format.
10228 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
10229 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
10230 # locality_lb_policy.
10231 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
10232 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
10233 # long and match the regular expression
10234 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
10235 # first character must be a lowercase letter, and all following
10236 # characters must be a dash, period, underscore, lowercase letter, or
10237 # digit, except the last character, which cannot be a dash, period, or
10238 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
10239 # field can only be used for a global or regional backend service with the
10240 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
10241 },
10242 ],
10243 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
10244 # custom
10245 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
10246 &quot;A String&quot;,
10247 ],
10248 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
10249 # custom
10250 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
10251 &quot;A String&quot;,
10252 ],
10253 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
10254 # create the resource.
10255 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
10256 # backend service with dynamic forwarding feature which together with Service
10257 # Extension allows customized and complex routing logic.
10258 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
10259 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
10260 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
10261 },
10262 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
10263 # service. Some ranges are restricted: Restricted
10264 # ranges.
10265 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
10266 },
10267 },
10268 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
10269 # this backend service.
10270 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
10271 # global external Application Load Balancer.
10272 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
10273 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
10274 #
10275 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
10276 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
10277 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
10278 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
10279 # externalManagedMigrationTestingPercentage.
10280 #
10281 # Rolling back a migration requires the states to be set in reverse order. So
10282 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
10283 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
10284 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
10285 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
10286 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
10287 # external Application Load Balancer.
10288 #
10289 # The value of this field must be in the range [0, 100].
10290 #
10291 # Session affinity options will slightly affect this routing behavior, for
10292 # more details, see:Session
10293 # Affinity.
10294 #
10295 # This value can only be set if the loadBalancingScheme in the BackendService
10296 # is set to EXTERNAL (when using the classic Application Load Balancer) and
10297 # the migration state is TEST_BY_PERCENTAGE.
10298 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
10299 # as a backup (failover) backend.
10300 # For load balancers that have configurable failover:
10301 # [Internal passthrough Network Load
10302 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10303 # and [external passthrough Network Load
10304 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10305 #
10306 # failoverPolicy cannot be specified with haPolicy.
10307 # failover:
10308 # [Internal passthrough Network Load
10309 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10310 # and [external passthrough
10311 # Network Load
10312 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10313 # On failover or failback, this field indicates whether connection draining
10314 # will be honored. Google Cloud has a fixed connection draining timeout of
10315 # 10 minutes. A setting of true terminates existing TCP
10316 # connections to the active pool during failover and failback, immediately
10317 # draining traffic. A setting of false allows existing TCP
10318 # connections to persist, even on VMs no longer in the active pool, for up
10319 # to the duration of the connection draining timeout (10 minutes).
10320 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
10321 #
10322 # The default is false.
10323 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
10324 # load balancer are dropped when all primary and all backup backend VMs are
10325 # unhealthy.If set to false, connections are distributed
10326 # among all primary VMs when all primary and all backup backend VMs are
10327 # unhealthy.
10328 # For load balancers that have configurable
10329 # failover:
10330 # [Internal passthrough
10331 # Network Load
10332 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10333 # and [external passthrough
10334 # Network Load
10335 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10336 # The default is false.
10337 &quot;failoverRatio&quot;: 3.14, # The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a
10338 # failover when the number of healthy primary VMs equals zero.
10339 # For all other values, the load balancer performs a failover when the
10340 # total number of healthy primary VMs is less than this ratio.
10341 # For load balancers that have configurable
10342 # failover:
10343 # [Internal TCP/UDP Load
10344 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10345 # and [external TCP/UDP Load
10346 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10347 },
10348 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
10349 # This field is used in optimistic locking. This field will be ignored when
10350 # inserting a BackendService. An up-to-date fingerprint must be provided in
10351 # order to update the BackendService, otherwise the request will
10352 # fail with error 412 conditionNotMet.
10353 #
10354 # To see the latest fingerprint, make a get() request to
10355 # retrieve a BackendService.
10356 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
10357 # Protocol Forwarding.
10358 #
10359 # The backends of this regional backend service must only specify zonal
10360 # network endpoint groups (NEGs) of type GCE_VM_IP.
10361 #
10362 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
10363 # regional backend service must set the network field. All zonal NEGs must
10364 # belong to the same network. However, individual NEGs can
10365 # belong to different subnetworks of that network.
10366 #
10367 # When haPolicy is specified, the set of attached network endpoints across
10368 # all backends comprise an High Availability domain from which one endpoint
10369 # is selected as the active endpoint (the leader) that receives all
10370 # traffic.
10371 #
10372 # haPolicy can be added only at backend service creation time. Once set up,
10373 # it cannot be deleted.
10374 #
10375 # Note that haPolicy is not for load balancing, and therefore cannot be
10376 # specified with sessionAffinity, connectionTrackingPolicy, and
10377 # failoverPolicy.
10378 #
10379 # haPolicy requires customers to be responsible for tracking backend
10380 # endpoint health and electing a leader among the healthy endpoints.
10381 # Therefore, haPolicy cannot be specified with healthChecks.
10382 #
10383 # haPolicy can only be specified for External Passthrough Network Load
10384 # Balancers and Internal Passthrough Network Load Balancers.
10385 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
10386 # achieve it.
10387 #
10388 # Supported values are:
10389 #
10390 # - DISABLED: Fast IP Move is disabled. You can only use the
10391 # haPolicy.leader API to update the leader.
10392 # - &gt;GARP_RA: Provides a method to very quickly define a new network
10393 # endpoint as the leader. This method is faster than updating the leader
10394 # using the haPolicy.leader API. Fast IP move works as follows: The VM
10395 # hosting the network endpoint that should become the new leader sends
10396 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
10397 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
10398 # temporarily associates the forwarding rule IP address with that VM, and
10399 # both new and in-flight packets are quickly delivered to that VM.
10400 #
10401 #
10402 #
10403 # Note the important properties of the Fast IP Move functionality:
10404 #
10405 # - The GARP/RA-initiated re-routing stays active for approximately 20
10406 # minutes. After triggering fast failover, you must also
10407 # appropriately set the haPolicy.leader.
10408 # - The new leader instance should continue to send GARP/RA packets
10409 # periodically every 10 seconds until at least 10 minutes after updating
10410 # the haPolicy.leader (but stop immediately if it is no longer the leader).
10411 # - After triggering a fast failover, we recommend that you wait at least
10412 # 3 seconds before sending another GARP/RA packet from a different VM
10413 # instance to avoid race conditions.
10414 # - Don&#x27;t send GARP/RA packets from different VM
10415 # instances at the same time. If multiple instances continue to send
10416 # GARP/RA packets, traffic might be routed to different destinations in an
10417 # alternating order. This condition ceases when a single instance
10418 # issues a GARP/RA packet.
10419 # - The GARP/RA request always takes priority over the leader API.
10420 # Using the haPolicy.leader API to change the leader to a different
10421 # instance will have no effect until the GARP/RA request becomes
10422 # inactive.
10423 # - The GARP/RA packets should follow the GARP/RA
10424 # Packet Specifications..
10425 # - When multiple forwarding rules refer to a regional backend service,
10426 # you need only send a GARP or RA packet for a single forwarding rule
10427 # virtual IP. The virtual IPs for all forwarding rules targeting the same
10428 # backend service will also be moved to the sender of the GARP or RA
10429 # packet.
10430 #
10431 #
10432 #
10433 # The following are the Fast IP Move limitations (that is, when fastIPMove
10434 # is not DISABLED):
10435 #
10436 # - Multiple forwarding rules cannot use the same IP address if one of
10437 # them refers to a regional backend service with fastIPMove.
10438 # - The regional backend service must set the network field, and all
10439 # NEGs must belong to that network. However, individual
10440 # NEGs can belong to different subnetworks of that network.
10441 # - The maximum number of network endpoints across all backends of a
10442 # backend service with fastIPMove is 32.
10443 # - The maximum number of backend services with fastIPMove that can have
10444 # the same network endpoint attached to one of its backends is 64.
10445 # - The maximum number of backend services with fastIPMove in a VPC in a
10446 # region is 64.
10447 # - The network endpoints that are attached to a backend of a backend
10448 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
10449 # - Traffic directed to the leader by a static route next hop will not be
10450 # redirected to a new leader by fast failover. Such traffic will only be
10451 # redirected once an haPolicy.leader update has taken effect. Only traffic
10452 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
10453 # fast failover.
10454 #
10455 #
10456 # haPolicy.fastIPMove can be set only at backend service creation time.
10457 # Once set, it cannot be updated.
10458 #
10459 # By default, fastIpMove is set to DISABLED.
10460 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
10461 # this service as the active endpoint (the leader) that receives all
10462 # traffic.
10463 #
10464 # When the leader changes, there is no connection draining to persist
10465 # existing connections on the old leader.
10466 #
10467 # You are responsible for selecting a suitable endpoint as the
10468 # leader. For example, preferring a healthy endpoint over unhealthy ones.
10469 # Note that this service does not track backend endpoint health, and
10470 # selects the configured leader unconditionally.
10471 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
10472 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
10473 # that the leader is attached to.
10474 #
10475 # The leader&#x27;s backendGroup must already be specified as a backend of
10476 # this backend service. Removing a backend that is designated as the
10477 # leader&#x27;s backendGroup is not permitted.
10478 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
10479 # designated as the leader.
10480 #
10481 # This network endpoint cannot be detached from the NEG specified in
10482 # the haPolicy.leader.backendGroup until the leader is updated with
10483 # another network endpoint, or the leader is removed from the haPolicy.
10484 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
10485 # instance must already be attached to the NEG specified in the
10486 # haPolicy.leader.backendGroup.
10487 #
10488 # The name must be 1-63 characters long, and comply with RFC1035.
10489 # Authorization requires the following IAM permission on the
10490 # specified resource instance: compute.instances.use
10491 },
10492 },
10493 },
10494 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
10495 # httpsHealthChecks (legacy) resource for health checking this backend
10496 # service. Not all backend services support legacy health checks. See
10497 # Load balancer guide. Currently, at most one health check can be
10498 # specified for each backend service. Backend services with
10499 # instance group or zonal NEG backends must have a health check unless
10500 # haPolicy is specified. Backend services with internet or serverless NEG
10501 # backends must not have a health check.
10502 #
10503 # healthChecks[] cannot be specified with haPolicy.
10504 &quot;A String&quot;,
10505 ],
10506 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
10507 # Not available for internal passthrough Network Load Balancers and external
10508 # passthrough Network Load Balancers.
10509 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
10510 # incoming requests.
10511 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
10512 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
10513 # For security reasons, this value cannot be retrieved via the API.
10514 # Instead, the SHA-256 hash of the value is returned in the
10515 # oauth2ClientSecretSha256 field.
10516 #
10517 # @InputOnly
10518 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
10519 },
10520 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
10521 # defined by the server.
10522 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
10523 # from the client to the backend for proxyless gRPC).
10524 # The possible values are:
10525 #
10526 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
10527 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10528 # Group), regardless of traffic from the client to the proxy. Only IPv4
10529 # health checks are used to check the health of the backends. This is the
10530 # default setting.
10531 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
10532 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
10533 # address).
10534 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
10535 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10536 # Group), regardless of traffic from the client to the proxy. Only IPv6
10537 # health checks are used to check the health of the backends.
10538 #
10539 #
10540 #
10541 # This field is applicable to either:
10542 #
10543 # - Advanced global external Application Load Balancer (load balancing
10544 # scheme EXTERNAL_MANAGED),
10545 # - Regional external Application Load
10546 # Balancer,
10547 # - Internal proxy Network Load Balancer (load balancing
10548 # scheme INTERNAL_MANAGED),
10549 # - Regional internal Application Load
10550 # Balancer (load balancing scheme INTERNAL_MANAGED),
10551 # - Traffic
10552 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
10553 # INTERNAL_SELF_MANAGED).
10554 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
10555 # for backend services.
10556 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
10557 # created for one type of load balancer cannot be used with another.
10558 # For more information, refer toChoosing
10559 # a load balancer.
10560 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
10561 # preference. When you use localityLbPolicies, you must set at least one
10562 # value for either the localityLbPolicies[].policy or the
10563 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
10564 # value set in the localityLbPolicy field.
10565 #
10566 # For an example of how to use this field, seeDefine
10567 # a list of preferred policies.
10568 #
10569 # Caution: This field and its children are intended for use in a service mesh
10570 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
10571 # that have this configuration.
10572 { # Container for either a built-in LB policy supported by gRPC or Envoy or
10573 # a custom one implemented by the end user.
10574 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
10575 # deployed with the client.
10576 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
10577 # by a locally installed custom policy implementation.
10578 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
10579 #
10580 # The value should match the name of a custom implementation registered
10581 # on the gRPC clients. It should follow protocol buffer message naming
10582 # conventions and include the full path (for example,
10583 # myorg.CustomLbPolicy). The maximum length is 256 characters.
10584 #
10585 # Do not specify the same custom policy more than once for a
10586 # backend. If you do, the configuration is rejected.
10587 #
10588 # For an example of how to use this field, seeUse
10589 # a custom policy.
10590 },
10591 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
10592 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
10593 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
10594 # about these values, see the description of localityLbPolicy.
10595 #
10596 # Do not specify the same policy more than once for a
10597 # backend. If you do, the configuration is rejected.
10598 },
10599 },
10600 ],
10601 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
10602 # possible values are:
10603 #
10604 # - ROUND_ROBIN: This is a simple policy in which each healthy
10605 # backend is selected in round robin order. This is the default.
10606 # - LEAST_REQUEST: An O(1) algorithm which
10607 # selects two random healthy hosts and picks the host which has fewer active
10608 # requests.
10609 # - RING_HASH: The ring/modulo hash load balancer implements
10610 # consistent hashing to backends. The algorithm has the property that the
10611 # addition/removal of a host from a set of N hosts only affects 1/N of the
10612 # requests.
10613 # - RANDOM: The load balancer selects a random healthy
10614 # host.
10615 # - ORIGINAL_DESTINATION: Backend host is selected
10616 # based on the client connection metadata, i.e., connections are opened to
10617 # the same address as the destination address of the incoming connection
10618 # before the connection was redirected to the load balancer.
10619 # - MAGLEV: used as a drop in replacement for the ring hash
10620 # load balancer. Maglev is not as stable as ring hash but has faster table
10621 # lookup build times and host selection times. For more information about
10622 # Maglev, see Maglev:
10623 # A Fast and Reliable Software Network Load Balancer.
10624 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
10625 # Load Balancing using weights computed from Backend reported Custom Metrics.
10626 # If set, the Backend Service responses are expected to contain non-standard
10627 # HTTP response header field Endpoint-Load-Metrics. The reported
10628 # metrics to use for computing the weights are specified via thecustomMetrics field.
10629 #
10630 # This field is applicable to either:
10631 # - A regional backend service with the service protocol set to HTTP,
10632 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10633 # INTERNAL_MANAGED.
10634 # - A global backend service with the
10635 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
10636 # EXTERNAL_MANAGED.
10637 #
10638 #
10639 # If sessionAffinity is not configured—that is, if session
10640 # affinity remains at the default value of NONE—then the
10641 # default value for localityLbPolicy
10642 # is ROUND_ROBIN. If session affinity is set to a value other
10643 # than NONE,
10644 # then the default value for localityLbPolicy isMAGLEV.
10645 #
10646 # Only ROUND_ROBIN and RING_HASH are supported
10647 # when the backend service is referenced by a URL map that is bound to
10648 # target gRPC proxy that has validateForProxyless field set to true.
10649 #
10650 # localityLbPolicy cannot be specified with haPolicy.
10651 &quot;logConfig&quot;: { # The available logging options for the load balancer traffic served by this # This field denotes the logging options for the load balancer traffic served
10652 # by this backend service. If logging is enabled, logs will be exported to
10653 # Stackdriver.
10654 # backend service.
10655 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
10656 # traffic served by this backend service. The default value is false.
10657 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
10658 { # Determines which HTTP headers will be logged to Stackdriver.
10659 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10660 },
10661 ],
10662 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
10663 { # Determines which HTTP headers will be logged to Stackdriver.
10664 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10665 },
10666 ],
10667 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
10668 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
10669 # of optional fields you want to include in the logs. For example:
10670 # serverInstance, serverGkeDetails.cluster,
10671 # serverGkeDetails.pod.podNamespace
10672 &quot;A String&quot;,
10673 ],
10674 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
10675 # service. Configures whether all, none or a subset of optional fields
10676 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
10677 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
10678 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
10679 # service. The value of the field must be in [0, 1]. This configures the
10680 # sampling rate of requests to the load balancer where 1.0 means all logged
10681 # requests are reported and 0.0 means no logged requests are reported. The
10682 # default value is 1.0.
10683 },
10684 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
10685 # service. Duration is computed from the beginning of the stream until the
10686 # response has been completely processed, including all retries. A stream
10687 # that does not complete in this duration is closed.
10688 #
10689 # If not specified, there will be no timeout limit, i.e. the maximum
10690 # duration is infinite.
10691 #
10692 # This value can be overridden in the PathMatcher configuration of the
10693 # UrlMap that references this backend service.
10694 #
10695 # This field is only allowed when the loadBalancingScheme of
10696 # the backend service is INTERNAL_SELF_MANAGED.
10697 # as a count of seconds and fractions of seconds at nanosecond
10698 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10699 # or &quot;month&quot;. Range is approximately 10,000 years.
10700 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10701 # Durations less than one second are represented with a 0
10702 # `seconds` field and a positive `nanos` field. Must be from 0
10703 # to 999,999,999 inclusive.
10704 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10705 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10706 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10707 },
10708 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
10709 # controller and read by the backend RCTH
10710 &quot;a_key&quot;: &quot;A String&quot;,
10711 },
10712 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
10713 # The name must be 1-63 characters long, and comply withRFC1035.
10714 # Specifically, the name must be 1-63 characters long and match the regular
10715 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10716 # character must be a lowercase letter, and all following characters must
10717 # be a dash, lowercase letter, or digit, except the last character, which
10718 # cannot be a dash.
10719 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
10720 #
10721 # This field must be set for Internal Passthrough Network Load Balancers when
10722 # the haPolicy is enabled, and for External Passthrough Network Load
10723 # Balancers when the haPolicy fastIpMove is enabled.
10724 #
10725 # This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
10726 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
10727 # Load Balancers.
10728 #
10729 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
10730 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
10731 # endpoints in the local zone.
10732 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
10733 # possible values are:
10734 #
10735 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
10736 # is disabled. The load balancer distributes new connections to all
10737 # healthy backend endpoints across all zones.
10738 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
10739 # enabled. The load balancer distributes new connections to all healthy
10740 # backend endpoints in the local zone only. If there are no healthy
10741 # backend endpoints in the local zone, the load balancer distributes
10742 # new connections to all backend endpoints in the local zone.
10743 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
10744 # enabled. The load balancer distributes new connections to all healthy
10745 # backend endpoints in the local zone only. If there aren&#x27;t enough
10746 # healthy backend endpoints in the local zone, the load balancer
10747 # distributes new connections to all healthy backend endpoints across all
10748 # zones.
10749 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
10750 # of healthy backend endpoints in a zone to the count of backend
10751 # endpoints in that same zone is equal to or above this threshold, the
10752 # load balancer distributes new connections to all healthy endpoints in
10753 # the local zone only. When the ratio of the count of healthy backend
10754 # endpoints in a zone to the count of backend endpoints in that same
10755 # zone is below this threshold, the load balancer distributes all new
10756 # connections to all healthy endpoints across all zones.
10757 },
10758 },
10759 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
10760 # the backend service.
10761 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
10762 # service.
10763 },
10764 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
10765 # load balancing pool of each individual proxy instance that processes the
10766 # traffic for the given backend service. If not set, this feature is
10767 # considered disabled.
10768 #
10769 # Results of the outlier detection algorithm (ejection of endpoints from the
10770 # load balancing pool and returning them back to the pool) are executed
10771 # independently by each proxy instance of the load balancer. In most cases,
10772 # more than one proxy instance handles the traffic received by a backend
10773 # service. Thus, it is possible that an unhealthy endpoint is detected and
10774 # ejected by only some of the proxies, and while this happens, other proxies
10775 # may continue to send requests to the same unhealthy endpoint until they
10776 # detect and eject the unhealthy endpoint.
10777 #
10778 # Applicable backend endpoints can be:
10779 #
10780 # - VM instances in an Instance Group
10781 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
10782 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
10783 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
10784 # Functions Services
10785 # - Private Service Connect NEGs, that resolve to
10786 # Google-managed regional API endpoints or managed services published using
10787 # Private Service Connect
10788 #
10789 #
10790 #
10791 # Applicable backend service types can be:
10792 #
10793 # - A global backend service with the loadBalancingScheme set to
10794 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
10795 # - A regional backend
10796 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
10797 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
10798 # supported for Serverless NEGs.
10799 #
10800 #
10801 #
10802 # Not supported when the backend service is referenced by a URL map that is
10803 # bound to target gRPC proxy that has validateForProxyless field set to true.
10804 # pool for the backend service.
10805 &quot;baseEjectionTime&quot;: { # A Duration represents a fixed-length span of time represented # The base time that a backend endpoint is ejected for. Defaults to 30000ms
10806 # or 30s.
10807 #
10808 # After a backend endpoint is returned back to the load balancing pool, it
10809 # can be ejected again in another ejection analysis. Thus, the total ejection
10810 # time is equal to the base ejection time multiplied by the number of times
10811 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
10812 # as a count of seconds and fractions of seconds at nanosecond
10813 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10814 # or &quot;month&quot;. Range is approximately 10,000 years.
10815 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10816 # Durations less than one second are represented with a 0
10817 # `seconds` field and a positive `nanos` field. Must be from 0
10818 # to 999,999,999 inclusive.
10819 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10820 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10821 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10822 },
10823 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
10824 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
10825 # return code qualifies as an error. Defaults to 5.
10826 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
10827 # connection errors that are mapped to one of those status codes) before a
10828 # consecutive gateway failure ejection occurs. Defaults to 3.
10829 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10830 # outlier status is detected through consecutive 5xx. This setting can be
10831 # used to disable ejection or to ramp it up slowly. Defaults to 0.
10832 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10833 # outlier status is detected through consecutive gateway failures. This
10834 # setting can be used to disable ejection or to ramp it up slowly. Defaults
10835 # to 100.
10836 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10837 # outlier status is detected through success rate statistics. This setting
10838 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
10839 #
10840 # Not supported when the backend service uses Serverless NEG.
10841 &quot;interval&quot;: { # A Duration represents a fixed-length span of time represented # Time interval between ejection analysis sweeps. This can result in both new
10842 # ejections and backend endpoints being returned to service. The interval is
10843 # equal to the number of seconds as defined in
10844 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
10845 # in outlierDetection.interval.nanos. Defaults to 1 second.
10846 # as a count of seconds and fractions of seconds at nanosecond
10847 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10848 # or &quot;month&quot;. Range is approximately 10,000 years.
10849 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10850 # Durations less than one second are represented with a 0
10851 # `seconds` field and a positive `nanos` field. Must be from 0
10852 # to 999,999,999 inclusive.
10853 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10854 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10855 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10856 },
10857 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
10858 # backend service that can be ejected if the ejection conditions are met.
10859 # Defaults to 50%.
10860 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
10861 # enough request volume to detect success rate outliers. If the number of
10862 # backend endpoints is fewer than this setting, outlier detection via success
10863 # rate statistics is not performed for any backend endpoint in the load
10864 # balancing pool. Defaults to 5.
10865 #
10866 # Not supported when the backend service uses Serverless NEG.
10867 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
10868 # (as defined by the interval duration above) to include this backend
10869 # endpoint in success rate based outlier detection. If the volume is lower
10870 # than this setting, outlier detection via success rate statistics is not
10871 # performed for that backend endpoint. Defaults to 100.
10872 #
10873 # Not supported when the backend service uses Serverless NEG.
10874 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
10875 # outlier ejection. The ejection threshold is the difference between the mean
10876 # success rate, and the product of this factor and the standard deviation of
10877 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
10878 # is divided by a thousand to get a double. That is, if the desired factor
10879 # is 1.9, the runtime value should be 1900. Defaults to 1900.
10880 #
10881 # Not supported when the backend service uses Serverless NEG.
10882 },
10883 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
10884 # as part of resource payload.
10885 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
10886 # Tag keys and values have the same definition as resource
10887 # manager tags. The field is allowed for INSERT
10888 # only. The keys/values to set on the resource should be specified in
10889 # either ID { : } or Namespaced format
10890 # { : }.
10891 # For example the following are valid inputs:
10892 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
10893 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
10894 # Note:
10895 # * Invalid combinations of ID &amp; namespaced format is not supported. For
10896 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
10897 &quot;a_key&quot;: &quot;A String&quot;,
10898 },
10899 },
10900 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
10901 # the backend. The default value is 80.
10902 # For internal passthrough Network Load Balancers and external passthrough
10903 # Network Load Balancers, omit port.
10904 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
10905 # communication to the backend VMs in that group. The
10906 # named port must be [defined on each backend instance
10907 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
10908 # This parameter has no meaning if the backends are NEGs. For internal
10909 # passthrough Network Load Balancers and external passthrough Network Load
10910 # Balancers, omit port_name.
10911 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
10912 # with backends.
10913 #
10914 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
10915 # depending on the chosen load balancer or Traffic Director configuration.
10916 # Refer to the documentation for the load balancers or for Traffic Director
10917 # for more information.
10918 #
10919 # Must be set to GRPC when the backend service is referenced by a URL map
10920 # that is bound to target gRPC proxy.
10921 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
10922 # resides. This field is not applicable to global backend services.
10923 # You must specify this field as part of the HTTP request URL. It is
10924 # not settable as a field in the request body.
10925 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
10926 # backend service.
10927 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
10928 # service. This field is applicable to a global backend service with the
10929 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
10930 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
10931 &quot;awsV4Authentication&quot;: { # Contains the configurations necessary to generate a signature for access to # The configuration needed to generate a signature for access to private
10932 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
10933 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
10934 # private storage buckets that support Signature Version 4 for authentication.
10935 # The service name for generating the authentication header will always default
10936 # to &#x27;s3&#x27;.
10937 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
10938 # creating a backend that uses AWS v4 signature authentication, but will not
10939 # be returned as part of the configuration when queried with a REST API GET
10940 # request.
10941 #
10942 # @InputOnly
10943 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
10944 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
10945 # keep track of different iterations of your access key.
10946 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
10947 # the name of the region your cloud uses to host your origin. For example,
10948 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
10949 },
10950 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
10951 # that describes how clients should authenticate with this service&#x27;s
10952 # backends.
10953 #
10954 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
10955 # to INTERNAL_SELF_MANAGED.
10956 #
10957 # If left blank, communications are not encrypted.
10958 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
10959 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
10960 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
10961 # specified values, the communication continues. Otherwise, it fails. This
10962 # additional check enables the client to verify that the server is authorized
10963 # to run the requested service.
10964 #
10965 # Note that the contents of the server
10966 # certificate&#x27;s subjectAltName field are configured by the
10967 # Public Key Infrastructure which provisions server identities.
10968 #
10969 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
10970 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
10971 # mode).
10972 &quot;A String&quot;,
10973 ],
10974 },
10975 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10976 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
10977 #
10978 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
10979 # If set, lists of backends and health checks must be both empty.
10980 &quot;A String&quot;,
10981 ],
10982 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
10983 #
10984 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
10985 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
10986 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
10987 #
10988 # Only NONE and HEADER_FIELD are supported
10989 # when the backend service is referenced by a URL map that is bound to
10990 # target gRPC proxy that has validateForProxyless field set to true.
10991 #
10992 # For more details, see:
10993 # [Session
10994 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
10995 #
10996 # sessionAffinity cannot be specified with haPolicy.
10997 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
10998 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
10999 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
11000 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
11001 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
11002 # as a count of seconds and fractions of seconds at nanosecond
11003 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11004 # or &quot;month&quot;. Range is approximately 10,000 years.
11005 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11006 # Durations less than one second are represented with a 0
11007 # `seconds` field and a positive `nanos` field. Must be from 0
11008 # to 999,999,999 inclusive.
11009 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11010 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11011 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11012 },
11013 },
11014 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
11015 # Currently this is applicable only for Internal TCP/UDP load balancing,
11016 # Internal HTTP(S) load balancing and Traffic Director.
11017 &quot;policy&quot;: &quot;A String&quot;,
11018 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
11019 # each service mesh client.
11020 #
11021 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
11022 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
11023 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
11024 # `INTERNAL_SELF_MANAGED`.
11025 #
11026 # `subset_size` is optional for Internal HTTP(S) load balancing
11027 # and required for Traffic Director.
11028 #
11029 # If you do not provide this value, Cloud Load Balancing will calculate it
11030 # dynamically to optimize the number of proxies/clients visible to each
11031 # backend and vice versa.
11032 #
11033 # Must be greater than 0. If `subset_size` is larger than the number of
11034 # backends/endpoints, then subsetting is disabled.
11035 },
11036 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
11037 # type of load balancer. For more information see,
11038 # Backend service settings.
11039 # The default is 30 seconds.
11040 # The full range of timeout values allowed goes from 1
11041 # through 2,147,483,647 seconds.
11042 #
11043 # This value can be overridden in the PathMatcher configuration of the
11044 # UrlMap that references this backend service.
11045 #
11046 # Not supported when the backend service is referenced by a URL map that is
11047 # bound to target gRPC proxy that has validateForProxyless field set to true.
11048 # Instead, use maxStreamDuration.
11049 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
11050 # when the backend protocol is SSL, HTTPS or HTTP2.
11051 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
11052 # networksecurity.googleapis.com namespace. Can be used in authenticating
11053 # TLS connections to the backend, as specified by the authenticationMode
11054 # field. Can only be specified if authenticationMode is not NONE.
11055 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
11056 #
11057 #
11058 # Use this property to configure the load balancer back-end to use
11059 # certificates and roots of trust provisioned by the Managed Workload
11060 # Identity system.
11061 #
11062 # The `identity` property is the
11063 # fully-specified SPIFFE ID to use in the SVID presented by the Load
11064 # Balancer Workload.
11065 #
11066 # The SPIFFE ID must be a resource starting with the
11067 # `trustDomain` property value, followed by the path to the Managed
11068 # Workload Identity.
11069 #
11070 # Supported SPIFFE ID format:
11071 #
11072 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
11073 #
11074 #
11075 # The Trust Domain within the Managed Identity must refer to a valid
11076 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
11077 # will be inherited from the Workload Identity Pool.
11078 #
11079 # Restrictions:
11080 #
11081 # - If you set the `identity` property, you cannot manually set
11082 # the following fields:
11083 # - tlsSettings.sni
11084 # - tlsSettings.subjectAltNames
11085 # - tlsSettings.authenticationConfig
11086 #
11087 #
11088 # When defining a `identity` for a RegionBackendServices, the
11089 # corresponding Workload Identity Pool must have a ca_pool
11090 # configured in the same region.
11091 #
11092 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
11093 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
11094 # balancer sends this string as the SNI hostname in the TLS connection to
11095 # the backend, and requires that this string match a Subject Alternative
11096 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
11097 # NEG backend, if the SNI is specified here, the load balancer uses it
11098 # regardless of whether the Regional Internet NEG is specified with FQDN or
11099 # IP address and port. When both sni and subjectAltNames[] are specified,
11100 # the load balancer matches the backend certificate&#x27;s SAN only to
11101 # subjectAltNames[].
11102 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
11103 # verifies during a TLS handshake with the backend. When the server
11104 # presents its X.509 certificate to the Load Balancer, the Load Balancer
11105 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
11106 # match one of the subjectAltNames in the list. This field is limited to 5
11107 # entries. When both sni and subjectAltNames[] are specified, the load
11108 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
11109 { # A Subject Alternative Name that the load balancer matches against the SAN
11110 # field in the TLS certificate provided by the backend, specified as either
11111 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
11112 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
11113 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
11114 },
11115 ],
11116 },
11117 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
11118 {
11119 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
11120 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
11121 # and ForwardingRule.
11122 },
11123 ],
11124 }
11125
11126 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11127 that if you must retry your request, the server will know to ignore the
11128 request if it has already been completed.
11129
11130 For example, consider a situation where you make an initial request and
11131 the request times out. If you make the request again with the same
11132 request ID, the server can check if original operation with the same
11133 request ID was received, and if so, will ignore the second request. This
11134 prevents clients from accidentally creating duplicate commitments.
11135
11136 The request ID must be
11137 a valid UUID with the exception that zero UUID is not supported
11138 (00000000-0000-0000-0000-000000000000).
11139 x__xgafv: string, V1 error format.
11140 Allowed values
11141 1 - v1 error format
11142 2 - v2 error format
11143
11144 Returns:
11145 An object of the form:
11146
11147 { # Represents an Operation resource.
11148 #
11149 # Google Compute Engine has three Operation resources:
11150 #
11151 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
11152 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
11153 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
11154 #
11155 # You can use an operation resource to manage asynchronous API requests.
11156 # For more information, readHandling
11157 # API responses.
11158 #
11159 # Operations can be global, regional or zonal.
11160 #
11161 # - For global operations, use the `globalOperations`
11162 # resource.
11163 # - For regional operations, use the
11164 # `regionOperations` resource.
11165 # - For zonal operations, use
11166 # the `zoneOperations` resource.
11167 #
11168 #
11169 #
11170 # For more information, read
11171 # Global, Regional, and Zonal Resources.
11172 #
11173 # Note that completed Operation resources have a limited
11174 # retention period.
11175 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11176 # Not present otherwise.
11177 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11178 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11179 # set when the operation is created.
11180 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11181 # text format.
11182 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11183 # this field will be populated.
11184 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11185 # operation.
11186 {
11187 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11188 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11189 # details. There is a set of defined message types to use for providing
11190 # details.The syntax depends on the error code. For example,
11191 # QuotaExceededInfo will have details when the error code is
11192 # QUOTA_EXCEEDED.
11193 {
11194 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11195 #
11196 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11197 # is not enabled:
11198 #
11199 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11200 # &quot;domain&quot;: &quot;googleapis.com&quot;
11201 # &quot;metadata&quot;: {
11202 # &quot;resource&quot;: &quot;projects/123&quot;,
11203 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11204 # }
11205 # }
11206 #
11207 # This response indicates that the pubsub.googleapis.com API is not enabled.
11208 #
11209 # Example of an error that is returned when attempting to create a Spanner
11210 # instance in a region that is out of stock:
11211 #
11212 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11213 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11214 # &quot;metadata&quot;: {
11215 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11216 # }
11217 # }
11218 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11219 # is typically the registered service name of the tool or product that
11220 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11221 # generated by some common infrastructure, the error domain must be a
11222 # globally unique value that identifies the infrastructure. For Google API
11223 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11224 &quot;metadatas&quot;: { # Additional structured details about this error.
11225 #
11226 # Keys must match a regular expression of `a-z+` but should
11227 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11228 # length. When identifying the current value of an exceeded limit, the units
11229 # should be contained in the key, not the value. For example, rather than
11230 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11231 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11232 # instances that can be created in a single (batch) request.
11233 &quot;a_key&quot;: &quot;A String&quot;,
11234 },
11235 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11236 # proximate cause of the error. Error reasons are unique within a particular
11237 # domain of errors. This should be at most 63 characters and match a
11238 # regular expression of `A-Z+[A-Z0-9]`, which represents
11239 # UPPER_SNAKE_CASE.
11240 },
11241 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11242 #
11243 # For example, if a quota check failed with an error indicating the calling
11244 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11245 # directly to the right place in the developer console to flip the bit.
11246 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11247 { # Describes a URL link.
11248 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11249 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11250 },
11251 ],
11252 },
11253 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11254 # which can be attached to an RPC error.
11255 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11256 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11257 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11258 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11259 },
11260 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11261 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11262 &quot;a_key&quot;: &quot;A String&quot;,
11263 },
11264 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11265 # type or metric.
11266 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11267 # or metric.
11268 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11269 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11270 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11271 },
11272 },
11273 ],
11274 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11275 # This property is optional.
11276 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11277 },
11278 ],
11279 },
11280 &quot;getVersionOperationMetadata&quot;: {
11281 &quot;inlineSbomInfo&quot;: {
11282 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11283 # appropriate identifiers.
11284 &quot;a_key&quot;: &quot;A String&quot;,
11285 },
11286 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11287 # identifiers.
11288 &quot;a_key&quot;: &quot;A String&quot;,
11289 },
11290 },
11291 },
11292 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11293 # message that was returned, such as `NOT FOUND`.
11294 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11295 # status code that was returned. For example, a `404` means the
11296 # resource was not found.
11297 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11298 # defined by the server.
11299 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11300 # This value is inRFC3339
11301 # text format.
11302 &quot;instancesBulkInsertOperationMetadata&quot;: {
11303 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11304 # Example key: zones/us-central1-a
11305 &quot;a_key&quot;: {
11306 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11307 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11308 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11309 # error.
11310 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11311 # if the flow is rolling forward or rolling back.
11312 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11313 },
11314 },
11315 },
11316 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11317 # Operation resources.
11318 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11319 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11320 # group of operations results from a `bulkInsert` API request.
11321 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11322 # `update`, or `delete`, and so on.
11323 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11324 # There is no requirement that this be linear or support any granularity of
11325 # operations. This should not be used to guess when the operation will be
11326 # complete. This number should monotonically increase as the operation
11327 # progresses.
11328 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11329 # applicable when performing regional operations.
11330 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11331 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11332 # this field will contain information on all underlying zonal actions and
11333 # their state.
11334 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11335 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11336 # Example key: zones/us-central1-a
11337 &quot;a_key&quot;: {
11338 &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
11339 # populated.
11340 # different programming environments, including REST APIs and RPC APIs. It is
11341 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11342 # three pieces of data: error code, error message, and error details.
11343 #
11344 # You can find out more about this error model and how to work with it in the
11345 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11346 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11347 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11348 # message types for APIs to use.
11349 {
11350 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11351 },
11352 ],
11353 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11354 # user-facing error message should be localized and sent in the
11355 # google.rpc.Status.details field, or localized by the client.
11356 },
11357 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11358 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11359 },
11360 },
11361 },
11362 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11363 # This value is inRFC3339
11364 # text format.
11365 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11366 # following:
11367 # `PENDING`, `RUNNING`, or `DONE`.
11368 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11369 # operation.
11370 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11371 # of the target resource.
11372 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11373 # operations related to creating a snapshot, this points to the disk
11374 # that the snapshot was created from.
11375 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11376 # `[email protected]` or
11377 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11378 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11379 # operation, this field will be populated.
11380 {
11381 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11382 # Engine returns NO_RESULTS_ON_PAGE if there
11383 # are no results in the response.
11384 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11385 # value format. For example:
11386 #
11387 # &quot;data&quot;: [
11388 # {
11389 # &quot;key&quot;: &quot;scope&quot;,
11390 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11391 # }
11392 {
11393 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11394 # returned. For example, for warnings where there are no results in a list
11395 # request for a particular zone, this key might be scope and
11396 # the key value might be the zone name. Other examples might be a key
11397 # indicating a deprecated resource and a suggested replacement, or a
11398 # warning about invalid network settings (for example, if an instance
11399 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11400 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11401 },
11402 ],
11403 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11404 },
11405 ],
11406 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11407 # applicable when performing per-zone operations.
11408 }</pre>
11409 </div>
11410
11411 </body></html>