Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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/v1/globalOperations)
162 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
163 # * [Zonal](/compute/docs/reference/rest/v1/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/v1/backendServices)
451 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/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;trafficDuration&quot;: &quot;A String&quot;,
586 },
587 ],
588 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
589 # specified load balancer types.
590 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
591 # Pragma or Authorization headers. Up to 5 headers can be specified.
592 # The cache is bypassed for all cdnPolicy.cacheMode settings.
593 { # Bypass the cache when the specified request headers are present,
594 # e.g. Pragma or Authorization headers. Values are case insensitive.
595 # The presence of such a header overrides the cache_mode setting.
596 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
597 # Values are case-insensitive.
598 },
599 ],
600 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
601 # CDN.
602 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
603 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
604 &quot;A String&quot;,
605 ],
606 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
607 # The name=value pair will be used in the cache key Cloud CDN generates.
608 &quot;A String&quot;,
609 ],
610 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
611 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
612 # query_string_whitelist and query_string_blacklist. If neither is set, the
613 # entire query string will be included. If false, the query string will be
614 # excluded from the cache key entirely.
615 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
616 # parameters will be included. Either specify query_string_whitelist or
617 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
618 # not treated as delimiters.
619 &quot;A String&quot;,
620 ],
621 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
622 # parameters will be excluded. Either specify query_string_whitelist or
623 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
624 # not treated as delimiters.
625 &quot;A String&quot;,
626 ],
627 },
628 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
629 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
630 # headers to cache content. Responses without these headers will not be
631 # cached at Google&#x27;s edge, and will require a full trip to the origin on
632 # every request, potentially impacting performance and increasing load on
633 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
634 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
635 # Warning: this may result in Cloud CDN caching private,
636 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
637 # including common image formats, media (video and audio), and web assets
638 # (JavaScript and CSS). Requests and responses that are marked as
639 # uncacheable, as well as dynamic content (including HTML), will not be
640 # cached.
641 #
642 # If no value is provided for cdnPolicy.cacheMode, it defaults
643 # to CACHE_ALL_STATIC.
644 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
645 # used to clamp the max-age (or Expires) value sent to the client. With
646 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
647 # response max-age directive, along with a &quot;public&quot; directive. For
648 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
649 # from the origin (if specified), or else sets the response max-age
650 # directive to the lesser of the client_ttl and default_ttl, and also
651 # ensures a &quot;public&quot; cache-control directive is present.
652 # If a client TTL is not specified, a default value (1 hour) will be used.
653 # The maximum allowed value is 31,622,400s (1 year).
654 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
655 # responses that do not have an existing valid TTL (max-age or s-maxage).
656 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
657 # The value of defaultTTL cannot be set to a value greater than that of
658 # maxTTL, but can be equal.
659 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
660 # will overwrite the TTL set in all responses. The maximum allowed value is
661 # 31,622,400s (1 year), noting that infrequently accessed objects may be
662 # evicted from the cache before the defined TTL.
663 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
664 # origin.
665 # Cache directives that attempt to set a max-age or s-maxage higher than
666 # this, or an Expires header more than maxTTL seconds in the future will
667 # be capped at the value of maxTTL, as if it were the value of an
668 # s-maxage Cache-Control directive.
669 # Headers sent to the client will not be modified.
670 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
671 # The maximum allowed value is 31,622,400s (1 year), noting that
672 # infrequently accessed objects may be evicted from the cache before
673 # the defined TTL.
674 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
675 # to apply fine-grained caching for common errors or redirects.
676 # This can reduce the load on your origin and improve end-user
677 # experience by reducing response latency.
678 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
679 # negative caching applies to responses with the specified response code
680 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
681 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
682 # to all responses with the specified response code, and override any
683 # caching headers.
684 # By default, Cloud CDN will apply the following default TTLs to these
685 # status codes:
686 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
687 # HTTP 404 (Not Found), 410 (Gone),
688 # 451 (Unavailable For Legal Reasons): 120s
689 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
690 # These defaults can be overridden in negative_caching_policy.
691 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
692 # negative_caching must be enabled to configure negative_caching_policy.
693 # Omitting the policy and leaving negative_caching enabled will use
694 # Cloud CDN&#x27;s default cache TTLs.
695 # Note that when specifying an explicit negative_caching_policy, you
696 # should take care to specify a cache TTL for all response codes
697 # that you wish to cache. Cloud CDN will not apply any default
698 # negative caching when a policy exists.
699 { # Specify CDN TTLs for response error codes.
700 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
701 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
702 # specified as values, and you cannot specify a status code more than
703 # once.
704 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
705 # corresponding status code.
706 # The maximum allowed value is 1800s (30 minutes), noting that
707 # infrequently accessed objects may be evicted from the cache before the
708 # defined TTL.
709 },
710 ],
711 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
712 # requests into a small number of requests to the origin.
713 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
714 # content with the origin, or when an error is encountered when refreshing
715 # the cache.
716 # This setting defines the default &quot;max-stale&quot; duration for any cached
717 # responses that do not specify a max-stale directive. Stale responses that
718 # exceed the TTL configured here will not be served. The default limit
719 # (max-stale) is 86400s (1 day), which will allow stale content to be
720 # served up to this limit beyond the max-age (or s-maxage) of a cached
721 # response.
722 # The maximum allowed value is 604800 (1 week).
723 # Set this to zero (0) to disable serve-while-stale.
724 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
725 # considered fresh. After this time period, the response will be
726 # revalidated before being served. Defaults to 1hr (3600s). When serving
727 # responses to signed URL requests, Cloud CDN will internally behave as
728 # though all responses from this backend had a &quot;Cache-Control:
729 # public, max-age=[TTL]&quot; header, regardless of any existing
730 # Cache-Control header. The actual headers served in responses will not be
731 # altered.
732 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
733 &quot;A String&quot;,
734 ],
735 },
736 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
737 # backend service.
738 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
739 # there is no limit.
740 #
741 # Not supported when the backend service is referenced by a URL map that is
742 # bound to target gRPC proxy that has validateForProxyless field set to true.
743 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
744 # not specified, there is no limit.
745 #
746 # Not supported when the backend service is referenced by a URL map that is
747 # bound to target gRPC proxy that has validateForProxyless field set to true.
748 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
749 # service. If not specified, there is no limit.
750 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
751 # This parameter is respected by both the HTTP/1.1 and HTTP/2
752 # implementations. If not specified, there is no limit. Setting this
753 # parameter to 1 will effectively disable keep alive.
754 #
755 # Not supported when the backend service is referenced by a URL map that is
756 # bound to target gRPC proxy that has validateForProxyless field set to true.
757 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
758 # not specified, the default is 1.
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 },
763 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
764 # the client&#x27;s Accept-Encoding header.
765 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
766 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
767 # instance. For supported load balancers and protocols, as described inEnabling
768 # connection draining.
769 },
770 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
771 # tracking policy settings are only available for external passthrough
772 # Network Load Balancers and internal passthrough Network Load Balancers.
773 #
774 # connectionTrackingPolicy cannot be specified with haPolicy.
775 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
776 # value is DEFAULT_FOR_PROTOCOL.
777 #
778 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
779 # persist on unhealthy backends only for connection-oriented protocols
780 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
781 # Affinity is configured for 5-tuple. They do not persist forUDP.
782 #
783 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
784 # the existing connections on the unhealthy backend are never persisted on
785 # the unhealthy backend. They are always diverted to newly selected healthy
786 # backends (unless all backends are unhealthy).
787 #
788 # If set to ALWAYS_PERSIST, existing connections always
789 # persist on unhealthy backends regardless of protocol and session
790 # affinity. It is generally not recommended to use this mode overriding the
791 # default.
792 #
793 # For more details, see [Connection Persistence for Network Load
794 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
795 # and [Connection Persistence for Internal TCP/UDP Load
796 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
797 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
798 # Balancers. This option is not available publicly.
799 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
800 # matching traffic (in seconds).
801 #
802 # For internal passthrough Network Load Balancers:
803 #
804 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
805 # - It can be set only if Connection Tracking is less than 5-tuple
806 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
807 # Mode is PER_SESSION).
808 #
809 #
810 #
811 # For external passthrough Network Load Balancers the default is 60
812 # seconds. This option is not available publicly.
813 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
814 # options:
815 #
816 # - PER_CONNECTION: This is the default mode. The Connection
817 # Tracking is performed as per the Connection Key (default Hash Method) for
818 # the specific protocol.
819 # - PER_SESSION: The Connection Tracking is performed as per
820 # the configured Session Affinity. It matches the configured Session
821 # Affinity.
822 #
823 #
824 #
825 # For more details, see [Tracking Mode for Network Load
826 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
827 # and [Tracking Mode for Internal TCP/UDP Load
828 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
829 },
830 &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
831 # affinity based on HTTP headers, cookies or other properties. This load
832 # balancing policy is applicable only for HTTP connections. The affinity to a
833 # particular destination host will be lost when one or more hosts are
834 # added/removed from the destination service. This field specifies parameters
835 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
836 #
837 # This field is applicable to either:
838 #
839 # - A regional backend service with the service protocol set to HTTP,
840 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
841 # INTERNAL_MANAGED.
842 # - A global backend service with the
843 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
844 &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
845 # be used as the hash key for the consistent hash load balancer. If the
846 # cookie is not present, it will be generated. This field is applicable if
847 # the sessionAffinity is set to HTTP_COOKIE.
848 #
849 # Not supported when the backend service is referenced by a URL map that is
850 # bound to target gRPC proxy that has validateForProxyless field set to true.
851 # for load balancing policies that use a consistent hash.
852 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
853 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
854 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
855 # as a count of seconds and fractions of seconds at nanosecond
856 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
857 # or &quot;month&quot;. Range is approximately 10,000 years.
858 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
859 # Durations less than one second are represented with a 0
860 # `seconds` field and a positive `nanos` field. Must be from 0
861 # to 999,999,999 inclusive.
862 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
863 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
864 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
865 },
866 },
867 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
868 # applicable if the sessionAffinity is set toHEADER_FIELD.
869 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
870 # 1024. Larger ring sizes result in more granular load distributions. If the
871 # number of hosts in the load balancing pool is larger than the ring size,
872 # each host will be assigned a single virtual node.
873 },
874 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
875 # text format.
876 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
877 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
878 # locality_lb_policy.
879 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
880 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
881 # long and match the regular expression
882 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
883 # first character must be a lowercase letter, and all following
884 # characters must be a dash, period, underscore, lowercase letter, or
885 # digit, except the last character, which cannot be a dash, period, or
886 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
887 # field can only be used for a global or regional backend service with the
888 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
889 },
890 ],
891 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
892 # custom
893 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
894 &quot;A String&quot;,
895 ],
896 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
897 # custom
898 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
899 &quot;A String&quot;,
900 ],
901 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
902 # create the resource.
903 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
904 # this backend service.
905 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
906 # global external Application Load Balancer.
907 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
908 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
909 #
910 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
911 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
912 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
913 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
914 # externalManagedMigrationTestingPercentage.
915 #
916 # Rolling back a migration requires the states to be set in reverse order. So
917 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
918 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
919 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
920 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
921 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
922 # external Application Load Balancer.
923 #
924 # The value of this field must be in the range [0, 100].
925 #
926 # Session affinity options will slightly affect this routing behavior, for
927 # more details, see:Session
928 # Affinity.
929 #
930 # This value can only be set if the loadBalancingScheme in the BackendService
931 # is set to EXTERNAL (when using the classic Application Load Balancer) and
932 # the migration state is TEST_BY_PERCENTAGE.
933 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
934 # as a backup (failover) backend.
935 # For load balancers that have configurable failover:
936 # [Internal passthrough Network Load
937 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
938 # and [external passthrough Network Load
939 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
940 #
941 # failoverPolicy cannot be specified with haPolicy.
942 # failover:
943 # [Internal passthrough Network Load
944 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
945 # and [external passthrough
946 # Network Load
947 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
948 # On failover or failback, this field indicates whether connection draining
949 # will be honored. Google Cloud has a fixed connection draining timeout of
950 # 10 minutes. A setting of true terminates existing TCP
951 # connections to the active pool during failover and failback, immediately
952 # draining traffic. A setting of false allows existing TCP
953 # connections to persist, even on VMs no longer in the active pool, for up
954 # to the duration of the connection draining timeout (10 minutes).
955 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
956 #
957 # The default is false.
958 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
959 # load balancer are dropped when all primary and all backup backend VMs are
960 # unhealthy.If set to false, connections are distributed
961 # among all primary VMs when all primary and all backup backend VMs are
962 # unhealthy.
963 # For load balancers that have configurable
964 # failover:
965 # [Internal passthrough
966 # Network Load
967 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
968 # and [external passthrough
969 # Network Load
970 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
971 # The default is false.
972 &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
973 # failover when the number of healthy primary VMs equals zero.
974 # For all other values, the load balancer performs a failover when the
975 # total number of healthy primary VMs is less than this ratio.
976 # For load balancers that have configurable
977 # failover:
978 # [Internal TCP/UDP Load
979 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
980 # and [external TCP/UDP Load
981 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
982 },
983 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
984 # This field is used in optimistic locking. This field will be ignored when
985 # inserting a BackendService. An up-to-date fingerprint must be provided in
986 # order to update the BackendService, otherwise the request will
987 # fail with error 412 conditionNotMet.
988 #
989 # To see the latest fingerprint, make a get() request to
990 # retrieve a BackendService.
991 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
992 # Protocol Forwarding.
993 #
994 # The backends of this regional backend service must only specify zonal
995 # network endpoint groups (NEGs) of type GCE_VM_IP.
996 #
997 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
998 # regional backend service must set the network field. All zonal NEGs must
999 # belong to the same network. However, individual NEGs can
1000 # belong to different subnetworks of that network.
1001 #
1002 # When haPolicy is specified, the set of attached network endpoints across
1003 # all backends comprise an High Availability domain from which one endpoint
1004 # is selected as the active endpoint (the leader) that receives all
1005 # traffic.
1006 #
1007 # haPolicy can be added only at backend service creation time. Once set up,
1008 # it cannot be deleted.
1009 #
1010 # Note that haPolicy is not for load balancing, and therefore cannot be
1011 # specified with sessionAffinity, connectionTrackingPolicy, and
1012 # failoverPolicy.
1013 #
1014 # haPolicy requires customers to be responsible for tracking backend
1015 # endpoint health and electing a leader among the healthy endpoints.
1016 # Therefore, haPolicy cannot be specified with healthChecks.
1017 #
1018 # haPolicy can only be specified for External Passthrough Network Load
1019 # Balancers and Internal Passthrough Network Load Balancers.
1020 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
1021 # achieve it.
1022 #
1023 # Supported values are:
1024 #
1025 # - DISABLED: Fast IP Move is disabled. You can only use the
1026 # haPolicy.leader API to update the leader.
1027 # - &gt;GARP_RA: Provides a method to very quickly define a new network
1028 # endpoint as the leader. This method is faster than updating the leader
1029 # using the haPolicy.leader API. Fast IP move works as follows: The VM
1030 # hosting the network endpoint that should become the new leader sends
1031 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
1032 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
1033 # temporarily associates the forwarding rule IP address with that VM, and
1034 # both new and in-flight packets are quickly delivered to that VM.
1035 #
1036 #
1037 #
1038 # Note the important properties of the Fast IP Move functionality:
1039 #
1040 # - The GARP/RA-initiated re-routing stays active for approximately 20
1041 # minutes. After triggering fast failover, you must also
1042 # appropriately set the haPolicy.leader.
1043 # - The new leader instance should continue to send GARP/RA packets
1044 # periodically every 10 seconds until at least 10 minutes after updating
1045 # the haPolicy.leader (but stop immediately if it is no longer the leader).
1046 # - After triggering a fast failover, we recommend that you wait at least
1047 # 3 seconds before sending another GARP/RA packet from a different VM
1048 # instance to avoid race conditions.
1049 # - Don&#x27;t send GARP/RA packets from different VM
1050 # instances at the same time. If multiple instances continue to send
1051 # GARP/RA packets, traffic might be routed to different destinations in an
1052 # alternating order. This condition ceases when a single instance
1053 # issues a GARP/RA packet.
1054 # - The GARP/RA request always takes priority over the leader API.
1055 # Using the haPolicy.leader API to change the leader to a different
1056 # instance will have no effect until the GARP/RA request becomes
1057 # inactive.
1058 # - The GARP/RA packets should follow the GARP/RA
1059 # Packet Specifications..
1060 # - When multiple forwarding rules refer to a regional backend service,
1061 # you need only send a GARP or RA packet for a single forwarding rule
1062 # virtual IP. The virtual IPs for all forwarding rules targeting the same
1063 # backend service will also be moved to the sender of the GARP or RA
1064 # packet.
1065 #
1066 #
1067 #
1068 # The following are the Fast IP Move limitations (that is, when fastIPMove
1069 # is not DISABLED):
1070 #
1071 # - Multiple forwarding rules cannot use the same IP address if one of
1072 # them refers to a regional backend service with fastIPMove.
1073 # - The regional backend service must set the network field, and all
1074 # NEGs must belong to that network. However, individual
1075 # NEGs can belong to different subnetworks of that network.
1076 # - The maximum number of network endpoints across all backends of a
1077 # backend service with fastIPMove is 32.
1078 # - The maximum number of backend services with fastIPMove that can have
1079 # the same network endpoint attached to one of its backends is 64.
1080 # - The maximum number of backend services with fastIPMove in a VPC in a
1081 # region is 64.
1082 # - The network endpoints that are attached to a backend of a backend
1083 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
1084 # - Traffic directed to the leader by a static route next hop will not be
1085 # redirected to a new leader by fast failover. Such traffic will only be
1086 # redirected once an haPolicy.leader update has taken effect. Only traffic
1087 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
1088 # fast failover.
1089 #
1090 #
1091 # haPolicy.fastIPMove can be set only at backend service creation time.
1092 # Once set, it cannot be updated.
1093 #
1094 # By default, fastIpMove is set to DISABLED.
1095 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
1096 # this service as the active endpoint (the leader) that receives all
1097 # traffic.
1098 #
1099 # When the leader changes, there is no connection draining to persist
1100 # existing connections on the old leader.
1101 #
1102 # You are responsible for selecting a suitable endpoint as the
1103 # leader. For example, preferring a healthy endpoint over unhealthy ones.
1104 # Note that this service does not track backend endpoint health, and
1105 # selects the configured leader unconditionally.
1106 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
1107 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
1108 # that the leader is attached to.
1109 #
1110 # The leader&#x27;s backendGroup must already be specified as a backend of
1111 # this backend service. Removing a backend that is designated as the
1112 # leader&#x27;s backendGroup is not permitted.
1113 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
1114 # designated as the leader.
1115 #
1116 # This network endpoint cannot be detached from the NEG specified in
1117 # the haPolicy.leader.backendGroup until the leader is updated with
1118 # another network endpoint, or the leader is removed from the haPolicy.
1119 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
1120 # instance must already be attached to the NEG specified in the
1121 # haPolicy.leader.backendGroup.
1122 #
1123 # The name must be 1-63 characters long, and comply with RFC1035.
1124 # Authorization requires the following IAM permission on the
1125 # specified resource instance: compute.instances.use
1126 },
1127 },
1128 },
1129 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
1130 # httpsHealthChecks (legacy) resource for health checking this backend
1131 # service. Not all backend services support legacy health checks. See
1132 # Load balancer guide. Currently, at most one health check can be
1133 # specified for each backend service. Backend services with
1134 # instance group or zonal NEG backends must have a health check unless
1135 # haPolicy is specified. Backend services with internet or serverless NEG
1136 # backends must not have a health check.
1137 #
1138 # healthChecks[] cannot be specified with haPolicy.
1139 &quot;A String&quot;,
1140 ],
1141 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
1142 # Not available for internal passthrough Network Load Balancers and external
1143 # passthrough Network Load Balancers.
1144 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
1145 # incoming requests.
1146 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
1147 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
1148 # For security reasons, this value cannot be retrieved via the API.
1149 # Instead, the SHA-256 hash of the value is returned in the
1150 # oauth2ClientSecretSha256 field.
1151 #
1152 # @InputOnly
1153 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
1154 },
1155 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1156 # defined by the server.
1157 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
1158 # from the client to the backend for proxyless gRPC).
1159 # The possible values are:
1160 #
1161 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
1162 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1163 # Group), regardless of traffic from the client to the proxy. Only IPv4
1164 # health checks are used to check the health of the backends. This is the
1165 # default setting.
1166 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
1167 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
1168 # address).
1169 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
1170 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1171 # Group), regardless of traffic from the client to the proxy. Only IPv6
1172 # health checks are used to check the health of the backends.
1173 #
1174 #
1175 #
1176 # This field is applicable to either:
1177 #
1178 # - Advanced global external Application Load Balancer (load balancing
1179 # scheme EXTERNAL_MANAGED),
1180 # - Regional external Application Load
1181 # Balancer,
1182 # - Internal proxy Network Load Balancer (load balancing
1183 # scheme INTERNAL_MANAGED),
1184 # - Regional internal Application Load
1185 # Balancer (load balancing scheme INTERNAL_MANAGED),
1186 # - Traffic
1187 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
1188 # INTERNAL_SELF_MANAGED).
1189 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
1190 # for backend services.
1191 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
1192 # created for one type of load balancer cannot be used with another.
1193 # For more information, refer toChoosing
1194 # a load balancer.
1195 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
1196 # preference. When you use localityLbPolicies, you must set at least one
1197 # value for either the localityLbPolicies[].policy or the
1198 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
1199 # value set in the localityLbPolicy field.
1200 #
1201 # For an example of how to use this field, seeDefine
1202 # a list of preferred policies.
1203 #
1204 # Caution: This field and its children are intended for use in a service mesh
1205 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
1206 # that have this configuration.
1207 { # Container for either a built-in LB policy supported by gRPC or Envoy or
1208 # a custom one implemented by the end user.
1209 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
1210 # deployed with the client.
1211 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
1212 # by a locally installed custom policy implementation.
1213 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
1214 #
1215 # The value should match the name of a custom implementation registered
1216 # on the gRPC clients. It should follow protocol buffer message naming
1217 # conventions and include the full path (for example,
1218 # myorg.CustomLbPolicy). The maximum length is 256 characters.
1219 #
1220 # Do not specify the same custom policy more than once for a
1221 # backend. If you do, the configuration is rejected.
1222 #
1223 # For an example of how to use this field, seeUse
1224 # a custom policy.
1225 },
1226 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
1227 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
1228 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
1229 # about these values, see the description of localityLbPolicy.
1230 #
1231 # Do not specify the same policy more than once for a
1232 # backend. If you do, the configuration is rejected.
1233 },
1234 },
1235 ],
1236 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
1237 # possible values are:
1238 #
1239 # - ROUND_ROBIN: This is a simple policy in which each healthy
1240 # backend is selected in round robin order. This is the default.
1241 # - LEAST_REQUEST: An O(1) algorithm which
1242 # selects two random healthy hosts and picks the host which has fewer active
1243 # requests.
1244 # - RING_HASH: The ring/modulo hash load balancer implements
1245 # consistent hashing to backends. The algorithm has the property that the
1246 # addition/removal of a host from a set of N hosts only affects 1/N of the
1247 # requests.
1248 # - RANDOM: The load balancer selects a random healthy
1249 # host.
1250 # - ORIGINAL_DESTINATION: Backend host is selected
1251 # based on the client connection metadata, i.e., connections are opened to
1252 # the same address as the destination address of the incoming connection
1253 # before the connection was redirected to the load balancer.
1254 # - MAGLEV: used as a drop in replacement for the ring hash
1255 # load balancer. Maglev is not as stable as ring hash but has faster table
1256 # lookup build times and host selection times. For more information about
1257 # Maglev, see Maglev:
1258 # A Fast and Reliable Software Network Load Balancer.
1259 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
1260 # Load Balancing using weights computed from Backend reported Custom Metrics.
1261 # If set, the Backend Service responses are expected to contain non-standard
1262 # HTTP response header field Endpoint-Load-Metrics. The reported
1263 # metrics to use for computing the weights are specified via thecustomMetrics field.
1264 #
1265 # This field is applicable to either:
1266 # - A regional backend service with the service protocol set to HTTP,
1267 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
1268 # INTERNAL_MANAGED.
1269 # - A global backend service with the
1270 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
1271 # EXTERNAL_MANAGED.
1272 #
1273 #
1274 # If sessionAffinity is not configured—that is, if session
1275 # affinity remains at the default value of NONE—then the
1276 # default value for localityLbPolicy
1277 # is ROUND_ROBIN. If session affinity is set to a value other
1278 # than NONE,
1279 # then the default value for localityLbPolicy isMAGLEV.
1280 #
1281 # Only ROUND_ROBIN and RING_HASH are supported
1282 # when the backend service is referenced by a URL map that is bound to
1283 # target gRPC proxy that has validateForProxyless field set to true.
1284 #
1285 # localityLbPolicy cannot be specified with haPolicy.
1286 &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
1287 # by this backend service. If logging is enabled, logs will be exported to
1288 # Stackdriver.
1289 # backend service.
1290 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
1291 # traffic served by this backend service. The default value is false.
1292 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
1293 { # Determines which HTTP headers will be logged to Stackdriver.
1294 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1295 },
1296 ],
1297 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
1298 { # Determines which HTTP headers will be logged to Stackdriver.
1299 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1300 },
1301 ],
1302 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
1303 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
1304 # of optional fields you want to include in the logs. For example:
1305 # serverInstance, serverGkeDetails.cluster,
1306 # serverGkeDetails.pod.podNamespace
1307 &quot;A String&quot;,
1308 ],
1309 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
1310 # service. Configures whether all, none or a subset of optional fields
1311 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1312 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1313 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
1314 # service. The value of the field must be in [0, 1]. This configures the
1315 # sampling rate of requests to the load balancer where 1.0 means all logged
1316 # requests are reported and 0.0 means no logged requests are reported. The
1317 # default value is 1.0.
1318 },
1319 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
1320 # service. Duration is computed from the beginning of the stream until the
1321 # response has been completely processed, including all retries. A stream
1322 # that does not complete in this duration is closed.
1323 #
1324 # If not specified, there will be no timeout limit, i.e. the maximum
1325 # duration is infinite.
1326 #
1327 # This value can be overridden in the PathMatcher configuration of the
1328 # UrlMap that references this backend service.
1329 #
1330 # This field is only allowed when the loadBalancingScheme of
1331 # the backend service is INTERNAL_SELF_MANAGED.
1332 # as a count of seconds and fractions of seconds at nanosecond
1333 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1334 # or &quot;month&quot;. Range is approximately 10,000 years.
1335 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1336 # Durations less than one second are represented with a 0
1337 # `seconds` field and a positive `nanos` field. Must be from 0
1338 # to 999,999,999 inclusive.
1339 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1340 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1341 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1342 },
1343 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
1344 # controller and read by the backend RCTH
1345 &quot;a_key&quot;: &quot;A String&quot;,
1346 },
1347 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1348 # The name must be 1-63 characters long, and comply withRFC1035.
1349 # Specifically, the name must be 1-63 characters long and match the regular
1350 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1351 # character must be a lowercase letter, and all following characters must
1352 # be a dash, lowercase letter, or digit, except the last character, which
1353 # cannot be a dash.
1354 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
1355 #
1356 # This field must be set for Internal Passthrough Network Load Balancers when
1357 # the haPolicy is enabled, and for External Passthrough Network Load
1358 # Balancers when the haPolicy fastIpMove is enabled.
1359 #
1360 # 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.
1361 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
1362 # Load Balancers.
1363 #
1364 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
1365 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
1366 # endpoints in the local zone.
1367 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
1368 # possible values are:
1369 #
1370 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
1371 # is disabled. The load balancer distributes new connections to all
1372 # healthy backend endpoints across all zones.
1373 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
1374 # enabled. The load balancer distributes new connections to all healthy
1375 # backend endpoints in the local zone only. If there are no healthy
1376 # backend endpoints in the local zone, the load balancer distributes
1377 # new connections to all backend endpoints in the local zone.
1378 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
1379 # enabled. The load balancer distributes new connections to all healthy
1380 # backend endpoints in the local zone only. If there aren&#x27;t enough
1381 # healthy backend endpoints in the local zone, the load balancer
1382 # distributes new connections to all healthy backend endpoints across all
1383 # zones.
1384 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
1385 # of healthy backend endpoints in a zone to the count of backend
1386 # endpoints in that same zone is equal to or above this threshold, the
1387 # load balancer distributes new connections to all healthy endpoints in
1388 # the local zone only. When the ratio of the count of healthy backend
1389 # endpoints in a zone to the count of backend endpoints in that same
1390 # zone is below this threshold, the load balancer distributes all new
1391 # connections to all healthy endpoints across all zones.
1392 },
1393 },
1394 &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.
1395 # the backend service.
1396 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
1397 # service.
1398 },
1399 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
1400 # load balancing pool of each individual proxy instance that processes the
1401 # traffic for the given backend service. If not set, this feature is
1402 # considered disabled.
1403 #
1404 # Results of the outlier detection algorithm (ejection of endpoints from the
1405 # load balancing pool and returning them back to the pool) are executed
1406 # independently by each proxy instance of the load balancer. In most cases,
1407 # more than one proxy instance handles the traffic received by a backend
1408 # service. Thus, it is possible that an unhealthy endpoint is detected and
1409 # ejected by only some of the proxies, and while this happens, other proxies
1410 # may continue to send requests to the same unhealthy endpoint until they
1411 # detect and eject the unhealthy endpoint.
1412 #
1413 # Applicable backend endpoints can be:
1414 #
1415 # - VM instances in an Instance Group
1416 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
1417 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
1418 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
1419 # Functions Services
1420 # - Private Service Connect NEGs, that resolve to
1421 # Google-managed regional API endpoints or managed services published using
1422 # Private Service Connect
1423 #
1424 #
1425 #
1426 # Applicable backend service types can be:
1427 #
1428 # - A global backend service with the loadBalancingScheme set to
1429 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
1430 # - A regional backend
1431 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
1432 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
1433 # supported for Serverless NEGs.
1434 #
1435 #
1436 #
1437 # Not supported when the backend service is referenced by a URL map that is
1438 # bound to target gRPC proxy that has validateForProxyless field set to true.
1439 # pool for the backend service.
1440 &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
1441 # or 30s.
1442 #
1443 # After a backend endpoint is returned back to the load balancing pool, it
1444 # can be ejected again in another ejection analysis. Thus, the total ejection
1445 # time is equal to the base ejection time multiplied by the number of times
1446 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
1447 # as a count of seconds and fractions of seconds at nanosecond
1448 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1449 # or &quot;month&quot;. Range is approximately 10,000 years.
1450 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1451 # Durations less than one second are represented with a 0
1452 # `seconds` field and a positive `nanos` field. Must be from 0
1453 # to 999,999,999 inclusive.
1454 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1455 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1456 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1457 },
1458 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
1459 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
1460 # return code qualifies as an error. Defaults to 5.
1461 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
1462 # connection errors that are mapped to one of those status codes) before a
1463 # consecutive gateway failure ejection occurs. Defaults to 3.
1464 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1465 # outlier status is detected through consecutive 5xx. This setting can be
1466 # used to disable ejection or to ramp it up slowly. Defaults to 0.
1467 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1468 # outlier status is detected through consecutive gateway failures. This
1469 # setting can be used to disable ejection or to ramp it up slowly. Defaults
1470 # to 100.
1471 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1472 # outlier status is detected through success rate statistics. This setting
1473 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
1474 #
1475 # Not supported when the backend service uses Serverless NEG.
1476 &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
1477 # ejections and backend endpoints being returned to service. The interval is
1478 # equal to the number of seconds as defined in
1479 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
1480 # in outlierDetection.interval.nanos. Defaults to 1 second.
1481 # as a count of seconds and fractions of seconds at nanosecond
1482 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1483 # or &quot;month&quot;. Range is approximately 10,000 years.
1484 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1485 # Durations less than one second are represented with a 0
1486 # `seconds` field and a positive `nanos` field. Must be from 0
1487 # to 999,999,999 inclusive.
1488 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1489 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1490 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1491 },
1492 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
1493 # backend service that can be ejected if the ejection conditions are met.
1494 # Defaults to 50%.
1495 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
1496 # enough request volume to detect success rate outliers. If the number of
1497 # backend endpoints is fewer than this setting, outlier detection via success
1498 # rate statistics is not performed for any backend endpoint in the load
1499 # balancing pool. Defaults to 5.
1500 #
1501 # Not supported when the backend service uses Serverless NEG.
1502 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
1503 # (as defined by the interval duration above) to include this backend
1504 # endpoint in success rate based outlier detection. If the volume is lower
1505 # than this setting, outlier detection via success rate statistics is not
1506 # performed for that backend endpoint. Defaults to 100.
1507 #
1508 # Not supported when the backend service uses Serverless NEG.
1509 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
1510 # outlier ejection. The ejection threshold is the difference between the mean
1511 # success rate, and the product of this factor and the standard deviation of
1512 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
1513 # is divided by a thousand to get a double. That is, if the desired factor
1514 # is 1.9, the runtime value should be 1900. Defaults to 1900.
1515 #
1516 # Not supported when the backend service uses Serverless NEG.
1517 },
1518 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1519 # as part of resource payload.
1520 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1521 # Tag keys and values have the same definition as resource
1522 # manager tags. The field is allowed for INSERT
1523 # only. The keys/values to set on the resource should be specified in
1524 # either ID { : } or Namespaced format
1525 # { : }.
1526 # For example the following are valid inputs:
1527 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1528 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1529 # Note:
1530 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1531 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1532 &quot;a_key&quot;: &quot;A String&quot;,
1533 },
1534 },
1535 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
1536 # the backend. The default value is 80.
1537 # For internal passthrough Network Load Balancers and external passthrough
1538 # Network Load Balancers, omit port.
1539 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
1540 # communication to the backend VMs in that group. The
1541 # named port must be [defined on each backend instance
1542 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
1543 # This parameter has no meaning if the backends are NEGs. For internal
1544 # passthrough Network Load Balancers and external passthrough Network Load
1545 # Balancers, omit port_name.
1546 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
1547 # with backends.
1548 #
1549 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
1550 # depending on the chosen load balancer or Traffic Director configuration.
1551 # Refer to the documentation for the load balancers or for Traffic Director
1552 # for more information.
1553 #
1554 # Must be set to GRPC when the backend service is referenced by a URL map
1555 # that is bound to target gRPC proxy.
1556 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
1557 # resides. This field is not applicable to global backend services.
1558 # You must specify this field as part of the HTTP request URL. It is
1559 # not settable as a field in the request body.
1560 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1561 # backend service.
1562 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
1563 # service. This field is applicable to a global backend service with the
1564 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
1565 &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
1566 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
1567 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
1568 # private storage buckets that support Signature Version 4 for authentication.
1569 # The service name for generating the authentication header will always default
1570 # to &#x27;s3&#x27;.
1571 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
1572 # creating a backend that uses AWS v4 signature authentication, but will not
1573 # be returned as part of the configuration when queried with a REST API GET
1574 # request.
1575 #
1576 # @InputOnly
1577 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
1578 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
1579 # keep track of different iterations of your access key.
1580 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
1581 # the name of the region your cloud uses to host your origin. For example,
1582 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
1583 },
1584 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
1585 # that describes how clients should authenticate with this service&#x27;s
1586 # backends.
1587 #
1588 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
1589 # to INTERNAL_SELF_MANAGED.
1590 #
1591 # If left blank, communications are not encrypted.
1592 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
1593 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
1594 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
1595 # specified values, the communication continues. Otherwise, it fails. This
1596 # additional check enables the client to verify that the server is authorized
1597 # to run the requested service.
1598 #
1599 # Note that the contents of the server
1600 # certificate&#x27;s subjectAltName field are configured by the
1601 # Public Key Infrastructure which provisions server identities.
1602 #
1603 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
1604 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
1605 # mode).
1606 &quot;A String&quot;,
1607 ],
1608 },
1609 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1610 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
1611 #
1612 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
1613 # If set, lists of backends and health checks must be both empty.
1614 &quot;A String&quot;,
1615 ],
1616 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
1617 #
1618 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
1619 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
1620 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
1621 #
1622 # Only NONE and HEADER_FIELD are supported
1623 # when the backend service is referenced by a URL map that is bound to
1624 # target gRPC proxy that has validateForProxyless field set to true.
1625 #
1626 # For more details, see:
1627 # [Session
1628 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
1629 #
1630 # sessionAffinity cannot be specified with haPolicy.
1631 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
1632 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
1633 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
1634 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
1635 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
1636 # as a count of seconds and fractions of seconds at nanosecond
1637 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1638 # or &quot;month&quot;. Range is approximately 10,000 years.
1639 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1640 # Durations less than one second are represented with a 0
1641 # `seconds` field and a positive `nanos` field. Must be from 0
1642 # to 999,999,999 inclusive.
1643 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1644 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1645 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1646 },
1647 },
1648 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
1649 # Currently this is applicable only for Internal TCP/UDP load balancing,
1650 # Internal HTTP(S) load balancing and Traffic Director.
1651 &quot;policy&quot;: &quot;A String&quot;,
1652 },
1653 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
1654 # type of load balancer. For more information see,
1655 # Backend service settings.
1656 # The default is 30 seconds.
1657 # The full range of timeout values allowed goes from 1
1658 # through 2,147,483,647 seconds.
1659 #
1660 # This value can be overridden in the PathMatcher configuration of the
1661 # UrlMap that references this backend service.
1662 #
1663 # Not supported when the backend service is referenced by a URL map that is
1664 # bound to target gRPC proxy that has validateForProxyless field set to true.
1665 # Instead, use maxStreamDuration.
1666 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
1667 # when the backend protocol is SSL, HTTPS or HTTP2.
1668 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
1669 # networksecurity.googleapis.com namespace. Can be used in authenticating
1670 # TLS connections to the backend, as specified by the authenticationMode
1671 # field. Can only be specified if authenticationMode is not NONE.
1672 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
1673 # balancer sends this string as the SNI hostname in the TLS connection to
1674 # the backend, and requires that this string match a Subject Alternative
1675 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
1676 # NEG backend, if the SNI is specified here, the load balancer uses it
1677 # regardless of whether the Regional Internet NEG is specified with FQDN or
1678 # IP address and port. When both sni and subjectAltNames[] are specified,
1679 # the load balancer matches the backend certificate&#x27;s SAN only to
1680 # subjectAltNames[].
1681 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
1682 # verifies during a TLS handshake with the backend. When the server
1683 # presents its X.509 certificate to the Load Balancer, the Load Balancer
1684 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
1685 # match one of the subjectAltNames in the list. This field is limited to 5
1686 # entries. When both sni and subjectAltNames[] are specified, the load
1687 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
1688 { # A Subject Alternative Name that the load balancer matches against the SAN
1689 # field in the TLS certificate provided by the backend, specified as either
1690 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
1691 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
1692 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
1693 },
1694 ],
1695 },
1696 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
1697 {
1698 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
1699 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
1700 # and ForwardingRule.
1701 },
1702 ],
1703 }</pre>
1704 </div>
1705
1706 <div class="method">
1707 <code class="details" id="getHealth">getHealth(project, region, backendService, body=None, x__xgafv=None)</code>
1708 <pre>Gets the most recent health check results for this
1709 regional BackendService.
1710
1711 Args:
1712 project: string, A parameter (required)
1713 region: string, Name of the region scoping this request. (required)
1714 backendService: string, Name of the BackendService resource for which to get health. (required)
1715 body: object, The request body.
1716 The object takes the form of:
1717
1718 {
1719 &quot;group&quot;: &quot;A String&quot;, # A URI referencing one of the instance groups or network endpoint groups
1720 # listed in the backend service.
1721 }
1722
1723 x__xgafv: string, V1 error format.
1724 Allowed values
1725 1 - v1 error format
1726 2 - v2 error format
1727
1728 Returns:
1729 An object of the form:
1730
1731 {
1732 &quot;annotations&quot;: { # Metadata defined as annotations on the network endpoint group.
1733 &quot;a_key&quot;: &quot;A String&quot;,
1734 },
1735 &quot;healthStatus&quot;: [ # Health state of the backend instances or endpoints in requested instance or
1736 # network endpoint group, determined based on configured health checks.
1737 {
1738 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
1739 &quot;a_key&quot;: &quot;A String&quot;,
1740 },
1741 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
1742 # instance.
1743 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
1744 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
1745 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
1746 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
1747 # rule&#x27;s IP address assigned to this instance. For other types of load
1748 # balancing, the field indicates VM internal ip.
1749 &quot;ipv6Address&quot;: &quot;A String&quot;,
1750 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
1751 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
1752 # health-checked.
1753 &quot;weight&quot;: &quot;A String&quot;,
1754 &quot;weightError&quot;: &quot;A String&quot;,
1755 },
1756 ],
1757 &quot;kind&quot;: &quot;compute#backendServiceGroupHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend
1758 # services.
1759 }</pre>
1760 </div>
1761
1762 <div class="method">
1763 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1764 <pre>Gets the access control policy for a resource. May be empty if no such
1765 policy or resource exists.
1766
1767 Args:
1768 project: string, Project ID for this request. (required)
1769 region: string, The name of the region for this request. (required)
1770 resource: string, Name or id of the resource for this request. (required)
1771 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1772 x__xgafv: string, V1 error format.
1773 Allowed values
1774 1 - v1 error format
1775 2 - v2 error format
1776
1777 Returns:
1778 An object of the form:
1779
1780 { # An Identity and Access Management (IAM) policy, which specifies access
1781 # controls for Google Cloud resources.
1782 #
1783 #
1784 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1785 # `members`, or principals, to a single `role`. Principals can be user
1786 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1787 # `role` is a named list of permissions; each `role` can be an IAM predefined
1788 # role or a user-created custom role.
1789 #
1790 # For some types of Google Cloud resources, a `binding` can also specify a
1791 # `condition`, which is a logical expression that allows access to a resource
1792 # only if the expression evaluates to `true`. A condition can add constraints
1793 # based on attributes of the request, the resource, or both. To learn which
1794 # resources support conditions in their IAM policies, see the
1795 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1796 #
1797 # **JSON example:**
1798 #
1799 # ```
1800 # {
1801 # &quot;bindings&quot;: [
1802 # {
1803 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1804 # &quot;members&quot;: [
1805 # &quot;user:[email protected]&quot;,
1806 # &quot;group:[email protected]&quot;,
1807 # &quot;domain:google.com&quot;,
1808 # &quot;serviceAccount:[email protected]&quot;
1809 # ]
1810 # },
1811 # {
1812 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1813 # &quot;members&quot;: [
1814 # &quot;user:[email protected]&quot;
1815 # ],
1816 # &quot;condition&quot;: {
1817 # &quot;title&quot;: &quot;expirable access&quot;,
1818 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1819 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1820 # }
1821 # }
1822 # ],
1823 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1824 # &quot;version&quot;: 3
1825 # }
1826 # ```
1827 #
1828 # **YAML example:**
1829 #
1830 # ```
1831 # bindings:
1832 # - members:
1833 # - user:[email protected]
1834 # - group:[email protected]
1835 # - domain:google.com
1836 # - serviceAccount:[email protected]
1837 # role: roles/resourcemanager.organizationAdmin
1838 # - members:
1839 # - user:[email protected]
1840 # role: roles/resourcemanager.organizationViewer
1841 # condition:
1842 # title: expirable access
1843 # description: Does not grant access after Sep 2020
1844 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1845 # etag: BwWWja0YfJA=
1846 # version: 3
1847 # ```
1848 #
1849 # For a description of IAM and its features, see the
1850 # [IAM documentation](https://cloud.google.com/iam/docs/).
1851 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1852 { # Specifies the audit configuration for a service.
1853 # The configuration determines which permission types are logged, and what
1854 # identities, if any, are exempted from logging.
1855 # An AuditConfig must have one or more AuditLogConfigs.
1856 #
1857 # If there are AuditConfigs for both `allServices` and a specific service,
1858 # the union of the two AuditConfigs is used for that service: the log_types
1859 # specified in each AuditConfig are enabled, and the exempted_members in each
1860 # AuditLogConfig are exempted.
1861 #
1862 # Example Policy with multiple AuditConfigs:
1863 #
1864 # {
1865 # &quot;audit_configs&quot;: [
1866 # {
1867 # &quot;service&quot;: &quot;allServices&quot;,
1868 # &quot;audit_log_configs&quot;: [
1869 # {
1870 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1871 # &quot;exempted_members&quot;: [
1872 # &quot;user:[email protected]&quot;
1873 # ]
1874 # },
1875 # {
1876 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1877 # },
1878 # {
1879 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1880 # }
1881 # ]
1882 # },
1883 # {
1884 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1885 # &quot;audit_log_configs&quot;: [
1886 # {
1887 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1888 # },
1889 # {
1890 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1891 # &quot;exempted_members&quot;: [
1892 # &quot;user:[email protected]&quot;
1893 # ]
1894 # }
1895 # ]
1896 # }
1897 # ]
1898 # }
1899 #
1900 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1901 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1902 # `[email protected]` from DATA_WRITE logging.
1903 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1904 { # Provides the configuration for logging a type of permissions.
1905 # Example:
1906 #
1907 # {
1908 # &quot;audit_log_configs&quot;: [
1909 # {
1910 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1911 # &quot;exempted_members&quot;: [
1912 # &quot;user:[email protected]&quot;
1913 # ]
1914 # },
1915 # {
1916 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1917 # }
1918 # ]
1919 # }
1920 #
1921 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1922 # [email protected] from DATA_READ logging.
1923 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1924 # permission.
1925 # Follows the same format of Binding.members.
1926 &quot;A String&quot;,
1927 ],
1928 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1929 },
1930 ],
1931 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1932 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1933 # `allServices` is a special value that covers all services.
1934 },
1935 ],
1936 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1937 # may specify a `condition` that determines how and when the `bindings` are
1938 # applied. Each of the `bindings` must contain at least one principal.
1939 #
1940 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1941 # of these principals can be Google groups. Each occurrence of a principal
1942 # counts towards these limits. For example, if the `bindings` grant 50
1943 # different roles to `user:[email protected]`, and not to any other
1944 # principal, then you can add another 1,450 principals to the `bindings` in
1945 # the `Policy`.
1946 { # Associates `members`, or principals, with a `role`.
1947 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1948 #
1949 # If the condition evaluates to `true`, then this binding applies to the
1950 # current request.
1951 #
1952 # If the condition evaluates to `false`, then this binding does not apply to
1953 # the current request. However, a different role binding might grant the same
1954 # role to one or more of the principals in this binding.
1955 #
1956 # To learn which resources support conditions in their IAM policies, see the
1957 # [IAM
1958 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1959 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1960 # are documented at https://github.com/google/cel-spec.
1961 #
1962 # Example (Comparison):
1963 #
1964 # title: &quot;Summary size limit&quot;
1965 # description: &quot;Determines if a summary is less than 100 chars&quot;
1966 # expression: &quot;document.summary.size() &lt; 100&quot;
1967 #
1968 # Example (Equality):
1969 #
1970 # title: &quot;Requestor is owner&quot;
1971 # description: &quot;Determines if requestor is the document owner&quot;
1972 # expression: &quot;document.owner == request.auth.claims.email&quot;
1973 #
1974 # Example (Logic):
1975 #
1976 # title: &quot;Public documents&quot;
1977 # description: &quot;Determine whether the document should be publicly visible&quot;
1978 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1979 #
1980 # Example (Data Manipulation):
1981 #
1982 # title: &quot;Notification string&quot;
1983 # description: &quot;Create a notification string with a timestamp.&quot;
1984 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1985 #
1986 # The exact variables and functions that may be referenced within an expression
1987 # are determined by the service that evaluates it. See the service
1988 # documentation for additional information.
1989 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1990 # describes the expression, e.g. when hovered over it in a UI.
1991 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1992 # syntax.
1993 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1994 # reporting, e.g. a file name and a position in the file.
1995 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1996 # its purpose. This can be used e.g. in UIs which allow to enter the
1997 # expression.
1998 },
1999 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2000 # `members` can have the following values:
2001 #
2002 # * `allUsers`: A special identifier that represents anyone who is
2003 # on the internet; with or without a Google account.
2004 #
2005 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2006 # who is authenticated with a Google account or a service account.
2007 # Does not include identities that come from external identity providers
2008 # (IdPs) through identity federation.
2009 #
2010 # * `user:{emailid}`: An email address that represents a specific Google
2011 # account. For example, `[email protected]` .
2012 #
2013 #
2014 # * `serviceAccount:{emailid}`: An email address that represents a Google
2015 # service account. For example,
2016 # `[email protected]`.
2017 #
2018 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2019 # identifier for a
2020 # [Kubernetes service
2021 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2022 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2023 #
2024 # * `group:{emailid}`: An email address that represents a Google group.
2025 # For example, `[email protected]`.
2026 #
2027 #
2028 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2029 # users of that domain. For example, `google.com` or `example.com`.
2030 #
2031 #
2032 #
2033 #
2034 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2035 # A single identity in a workforce identity pool.
2036 #
2037 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2038 # All workforce identities in a group.
2039 #
2040 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2041 # All workforce identities with a specific attribute value.
2042 #
2043 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2044 # All identities in a workforce identity pool.
2045 #
2046 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2047 # A single identity in a workload identity pool.
2048 #
2049 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2050 # A workload identity pool group.
2051 #
2052 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2053 # All identities in a workload identity pool with a certain attribute.
2054 #
2055 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2056 # All identities in a workload identity pool.
2057 #
2058 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2059 # identifier) representing a user that has been recently deleted. For
2060 # example, `[email protected]?uid=123456789012345678901`. If the user is
2061 # recovered, this value reverts to `user:{emailid}` and the recovered user
2062 # retains the role in the binding.
2063 #
2064 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2065 # unique identifier) representing a service account that has been recently
2066 # deleted. For example,
2067 # `[email protected]?uid=123456789012345678901`.
2068 # If the service account is undeleted, this value reverts to
2069 # `serviceAccount:{emailid}` and the undeleted service account retains the
2070 # role in the binding.
2071 #
2072 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2073 # identifier) representing a Google group that has been recently
2074 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2075 # the group is recovered, this value reverts to `group:{emailid}` and the
2076 # recovered group retains the role in the binding.
2077 #
2078 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2079 # Deleted single identity in a workforce identity pool. For example,
2080 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2081 &quot;A String&quot;,
2082 ],
2083 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2084 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2085 #
2086 # For an overview of the IAM roles and permissions, see the
2087 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2088 # a list of the available pre-defined roles, see
2089 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2090 },
2091 ],
2092 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2093 # prevent simultaneous updates of a policy from overwriting each other.
2094 # It is strongly suggested that systems make use of the `etag` in the
2095 # read-modify-write cycle to perform policy updates in order to avoid race
2096 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2097 # systems are expected to put that etag in the request to `setIamPolicy` to
2098 # ensure that their change will be applied to the same version of the policy.
2099 #
2100 # **Important:** If you use IAM Conditions, you must include the `etag` field
2101 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2102 # you to overwrite a version `3` policy with a version `1` policy, and all of
2103 # the conditions in the version `3` policy are lost.
2104 &quot;version&quot;: 42, # Specifies the format of the policy.
2105 #
2106 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2107 # are rejected.
2108 #
2109 # Any operation that affects conditional role bindings must specify version
2110 # `3`. This requirement applies to the following operations:
2111 #
2112 # * Getting a policy that includes a conditional role binding
2113 # * Adding a conditional role binding to a policy
2114 # * Changing a conditional role binding in a policy
2115 # * Removing any role binding, with or without a condition, from a policy
2116 # that includes conditions
2117 #
2118 # **Important:** If you use IAM Conditions, you must include the `etag` field
2119 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2120 # you to overwrite a version `3` policy with a version `1` policy, and all of
2121 # the conditions in the version `3` policy are lost.
2122 #
2123 # If a policy does not include any conditions, operations on that policy may
2124 # specify any valid version or leave the field unset.
2125 #
2126 # To learn which resources support conditions in their IAM policies, see the
2127 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2128 }</pre>
2129 </div>
2130
2131 <div class="method">
2132 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
2133 <pre>Creates a regional BackendService resource in the specified project using
2134 the data included in the request. For more information, see
2135 Backend services overview.
2136
2137 Args:
2138 project: string, Project ID for this request. (required)
2139 region: string, Name of the region scoping this request. (required)
2140 body: object, The request body.
2141 The object takes the form of:
2142
2143 { # Represents a Backend Service resource.
2144 #
2145 # A backend service defines how Google Cloud load balancers distribute traffic.
2146 # The backend service configuration contains a set of values, such as the
2147 # protocol used to connect to backends, various distribution and session
2148 # settings, health checks, and timeouts. These settings provide fine-grained
2149 # control over how your load balancer behaves. Most of the settings have
2150 # default values that allow for easy configuration if you need to get started
2151 # quickly.
2152 #
2153 # Backend services in Google Compute Engine can be either regionally or
2154 # globally scoped.
2155 #
2156 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
2157 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
2158 #
2159 # For more information, seeBackend
2160 # Services.
2161 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
2162 # Load Balancers and Traffic Director and requires
2163 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
2164 #
2165 # If set to 0, the cookie is non-persistent and lasts only until
2166 # the end of the browser session (or equivalent). The maximum allowed value
2167 # is two weeks (1,209,600).
2168 #
2169 # Not supported when the backend service is referenced by a URL map that is
2170 # bound to target gRPC proxy that has validateForProxyless field set to true.
2171 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
2172 { # Message containing information of one individual backend.
2173 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
2174 # handle additional traffic or is fully loaded. For usage guidelines, see
2175 # Connection balancing mode.
2176 #
2177 # Backends must use compatible balancing modes. For more information, see
2178 # Supported balancing modes and target capacity settings and
2179 # Restrictions and guidance for instance groups.
2180 #
2181 # Note: Currently, if you use the API to configure incompatible balancing
2182 # modes, the configuration might be accepted even though it has no impact
2183 # and is ignored. Specifically, Backend.maxUtilization is ignored when
2184 # Backend.balancingMode is RATE. In the future, this incompatible combination
2185 # will be rejected.
2186 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
2187 # mode.
2188 # The default value is 1, which means the group serves up to
2189 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
2190 # completely drained, offering 0% of its available capacity. The valid ranges
2191 # are 0.0 and [0.1,1.0].
2192 # You cannot configure a setting larger than 0 and smaller than0.1.
2193 # You cannot configure a setting of 0 when there is only one
2194 # backend attached to the backend service.
2195 #
2196 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
2197 # internet NEGs, regional serverless NEGs, and PSC NEGs.
2198 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
2199 # BalancingMode.
2200 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
2201 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
2202 # Monitoring, but is not used for load balancing.
2203 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
2204 # balancing mode. The valid range is [0.0, 1.0].
2205 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2206 # long and match the regular expression
2207 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2208 # first character must be a lowercase letter, and all following
2209 # characters must be a dash, period, underscore, lowercase letter, or
2210 # digit, except the last character, which cannot be a dash, period, or
2211 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2212 # field can only be used for a global or regional backend service with the
2213 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2214 },
2215 ],
2216 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2217 # create the resource.
2218 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
2219 # failover backend can be configured for a given BackendService.
2220 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
2221 # group or network endpoint
2222 # group (NEG) resource. To determine what types of backends a load
2223 # balancer supports, see the [Backend services
2224 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
2225 #
2226 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
2227 # or NEG. Partial URLs are not supported.
2228 #
2229 # If haPolicy is specified, backends must refer to NEG resources of type
2230 # GCE_VM_IP.
2231 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2232 # guidelines, seeConnection
2233 # balancing mode and Utilization
2234 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
2235 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2236 # guidelines, seeConnection
2237 # balancing mode and Utilization
2238 # balancing mode.
2239 #
2240 # Not available if the backend&#x27;s balancingMode isRATE.
2241 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
2242 # For usage guidelines, seeConnection
2243 # balancing mode and Utilization
2244 # balancing mode.
2245 #
2246 # Not available if the backend&#x27;s balancingMode isRATE.
2247 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
2248 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
2249 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
2250 # Not available if backend&#x27;s balancingMode is RATE
2251 # or CONNECTION.
2252 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
2253 # Not available if backend&#x27;s balancingMode is RATE
2254 # or CONNECTION.
2255 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
2256 # usage guidelines, seeRate
2257 # balancing mode and Utilization
2258 # balancing mode.
2259 #
2260 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2261 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2262 # guidelines, seeRate
2263 # balancing mode and Utilization
2264 # balancing mode.
2265 #
2266 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2267 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2268 # guidelines, seeRate
2269 # balancing mode and Utilization
2270 # balancing mode.
2271 #
2272 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2273 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
2274 #
2275 # For usage guidelines, seeUtilization
2276 # balancing mode.
2277 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
2278 # the backend.
2279 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
2280 },
2281 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
2282 # sending traffic to backends with default preference. The possible values
2283 # are:
2284 #
2285 # - PREFERRED: Backends with this preference level will be
2286 # filled up to their capacity limits first, based on RTT.
2287 # - DEFAULT: If preferred backends don&#x27;t have enough
2288 # capacity, backends in this layer would be used and traffic would be
2289 # assigned based on the load balancing algorithm you use. This is the
2290 # default
2291 &quot;trafficDuration&quot;: &quot;A String&quot;,
2292 },
2293 ],
2294 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
2295 # specified load balancer types.
2296 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2297 # Pragma or Authorization headers. Up to 5 headers can be specified.
2298 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2299 { # Bypass the cache when the specified request headers are present,
2300 # e.g. Pragma or Authorization headers. Values are case insensitive.
2301 # The presence of such a header overrides the cache_mode setting.
2302 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2303 # Values are case-insensitive.
2304 },
2305 ],
2306 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
2307 # CDN.
2308 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
2309 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2310 &quot;A String&quot;,
2311 ],
2312 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
2313 # The name=value pair will be used in the cache key Cloud CDN generates.
2314 &quot;A String&quot;,
2315 ],
2316 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
2317 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
2318 # query_string_whitelist and query_string_blacklist. If neither is set, the
2319 # entire query string will be included. If false, the query string will be
2320 # excluded from the cache key entirely.
2321 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
2322 # parameters will be included. Either specify query_string_whitelist or
2323 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2324 # not treated as delimiters.
2325 &quot;A String&quot;,
2326 ],
2327 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
2328 # parameters will be excluded. Either specify query_string_whitelist or
2329 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2330 # not treated as delimiters.
2331 &quot;A String&quot;,
2332 ],
2333 },
2334 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2335 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2336 # headers to cache content. Responses without these headers will not be
2337 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2338 # every request, potentially impacting performance and increasing load on
2339 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2340 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2341 # Warning: this may result in Cloud CDN caching private,
2342 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2343 # including common image formats, media (video and audio), and web assets
2344 # (JavaScript and CSS). Requests and responses that are marked as
2345 # uncacheable, as well as dynamic content (including HTML), will not be
2346 # cached.
2347 #
2348 # If no value is provided for cdnPolicy.cacheMode, it defaults
2349 # to CACHE_ALL_STATIC.
2350 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2351 # used to clamp the max-age (or Expires) value sent to the client. With
2352 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2353 # response max-age directive, along with a &quot;public&quot; directive. For
2354 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2355 # from the origin (if specified), or else sets the response max-age
2356 # directive to the lesser of the client_ttl and default_ttl, and also
2357 # ensures a &quot;public&quot; cache-control directive is present.
2358 # If a client TTL is not specified, a default value (1 hour) will be used.
2359 # The maximum allowed value is 31,622,400s (1 year).
2360 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2361 # responses that do not have an existing valid TTL (max-age or s-maxage).
2362 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2363 # The value of defaultTTL cannot be set to a value greater than that of
2364 # maxTTL, but can be equal.
2365 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2366 # will overwrite the TTL set in all responses. The maximum allowed value is
2367 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2368 # evicted from the cache before the defined TTL.
2369 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2370 # origin.
2371 # Cache directives that attempt to set a max-age or s-maxage higher than
2372 # this, or an Expires header more than maxTTL seconds in the future will
2373 # be capped at the value of maxTTL, as if it were the value of an
2374 # s-maxage Cache-Control directive.
2375 # Headers sent to the client will not be modified.
2376 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2377 # The maximum allowed value is 31,622,400s (1 year), noting that
2378 # infrequently accessed objects may be evicted from the cache before
2379 # the defined TTL.
2380 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2381 # to apply fine-grained caching for common errors or redirects.
2382 # This can reduce the load on your origin and improve end-user
2383 # experience by reducing response latency.
2384 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2385 # negative caching applies to responses with the specified response code
2386 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2387 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2388 # to all responses with the specified response code, and override any
2389 # caching headers.
2390 # By default, Cloud CDN will apply the following default TTLs to these
2391 # status codes:
2392 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2393 # HTTP 404 (Not Found), 410 (Gone),
2394 # 451 (Unavailable For Legal Reasons): 120s
2395 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2396 # These defaults can be overridden in negative_caching_policy.
2397 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2398 # negative_caching must be enabled to configure negative_caching_policy.
2399 # Omitting the policy and leaving negative_caching enabled will use
2400 # Cloud CDN&#x27;s default cache TTLs.
2401 # Note that when specifying an explicit negative_caching_policy, you
2402 # should take care to specify a cache TTL for all response codes
2403 # that you wish to cache. Cloud CDN will not apply any default
2404 # negative caching when a policy exists.
2405 { # Specify CDN TTLs for response error codes.
2406 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2407 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2408 # specified as values, and you cannot specify a status code more than
2409 # once.
2410 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2411 # corresponding status code.
2412 # The maximum allowed value is 1800s (30 minutes), noting that
2413 # infrequently accessed objects may be evicted from the cache before the
2414 # defined TTL.
2415 },
2416 ],
2417 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2418 # requests into a small number of requests to the origin.
2419 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2420 # content with the origin, or when an error is encountered when refreshing
2421 # the cache.
2422 # This setting defines the default &quot;max-stale&quot; duration for any cached
2423 # responses that do not specify a max-stale directive. Stale responses that
2424 # exceed the TTL configured here will not be served. The default limit
2425 # (max-stale) is 86400s (1 day), which will allow stale content to be
2426 # served up to this limit beyond the max-age (or s-maxage) of a cached
2427 # response.
2428 # The maximum allowed value is 604800 (1 week).
2429 # Set this to zero (0) to disable serve-while-stale.
2430 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2431 # considered fresh. After this time period, the response will be
2432 # revalidated before being served. Defaults to 1hr (3600s). When serving
2433 # responses to signed URL requests, Cloud CDN will internally behave as
2434 # though all responses from this backend had a &quot;Cache-Control:
2435 # public, max-age=[TTL]&quot; header, regardless of any existing
2436 # Cache-Control header. The actual headers served in responses will not be
2437 # altered.
2438 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2439 &quot;A String&quot;,
2440 ],
2441 },
2442 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
2443 # backend service.
2444 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
2445 # there is no limit.
2446 #
2447 # Not supported when the backend service is referenced by a URL map that is
2448 # bound to target gRPC proxy that has validateForProxyless field set to true.
2449 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
2450 # not specified, there is no limit.
2451 #
2452 # Not supported when the backend service is referenced by a URL map that is
2453 # bound to target gRPC proxy that has validateForProxyless field set to true.
2454 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
2455 # service. If not specified, there is no limit.
2456 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
2457 # This parameter is respected by both the HTTP/1.1 and HTTP/2
2458 # implementations. If not specified, there is no limit. Setting this
2459 # parameter to 1 will effectively disable keep alive.
2460 #
2461 # Not supported when the backend service is referenced by a URL map that is
2462 # bound to target gRPC proxy that has validateForProxyless field set to true.
2463 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
2464 # not specified, the default is 1.
2465 #
2466 # Not supported when the backend service is referenced by a URL map that is
2467 # bound to target gRPC proxy that has validateForProxyless field set to true.
2468 },
2469 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2470 # the client&#x27;s Accept-Encoding header.
2471 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
2472 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
2473 # instance. For supported load balancers and protocols, as described inEnabling
2474 # connection draining.
2475 },
2476 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
2477 # tracking policy settings are only available for external passthrough
2478 # Network Load Balancers and internal passthrough Network Load Balancers.
2479 #
2480 # connectionTrackingPolicy cannot be specified with haPolicy.
2481 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
2482 # value is DEFAULT_FOR_PROTOCOL.
2483 #
2484 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
2485 # persist on unhealthy backends only for connection-oriented protocols
2486 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
2487 # Affinity is configured for 5-tuple. They do not persist forUDP.
2488 #
2489 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
2490 # the existing connections on the unhealthy backend are never persisted on
2491 # the unhealthy backend. They are always diverted to newly selected healthy
2492 # backends (unless all backends are unhealthy).
2493 #
2494 # If set to ALWAYS_PERSIST, existing connections always
2495 # persist on unhealthy backends regardless of protocol and session
2496 # affinity. It is generally not recommended to use this mode overriding the
2497 # default.
2498 #
2499 # For more details, see [Connection Persistence for Network Load
2500 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
2501 # and [Connection Persistence for Internal TCP/UDP Load
2502 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
2503 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
2504 # Balancers. This option is not available publicly.
2505 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
2506 # matching traffic (in seconds).
2507 #
2508 # For internal passthrough Network Load Balancers:
2509 #
2510 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
2511 # - It can be set only if Connection Tracking is less than 5-tuple
2512 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
2513 # Mode is PER_SESSION).
2514 #
2515 #
2516 #
2517 # For external passthrough Network Load Balancers the default is 60
2518 # seconds. This option is not available publicly.
2519 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
2520 # options:
2521 #
2522 # - PER_CONNECTION: This is the default mode. The Connection
2523 # Tracking is performed as per the Connection Key (default Hash Method) for
2524 # the specific protocol.
2525 # - PER_SESSION: The Connection Tracking is performed as per
2526 # the configured Session Affinity. It matches the configured Session
2527 # Affinity.
2528 #
2529 #
2530 #
2531 # For more details, see [Tracking Mode for Network Load
2532 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
2533 # and [Tracking Mode for Internal TCP/UDP Load
2534 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
2535 },
2536 &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
2537 # affinity based on HTTP headers, cookies or other properties. This load
2538 # balancing policy is applicable only for HTTP connections. The affinity to a
2539 # particular destination host will be lost when one or more hosts are
2540 # added/removed from the destination service. This field specifies parameters
2541 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
2542 #
2543 # This field is applicable to either:
2544 #
2545 # - A regional backend service with the service protocol set to HTTP,
2546 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
2547 # INTERNAL_MANAGED.
2548 # - A global backend service with the
2549 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
2550 &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
2551 # be used as the hash key for the consistent hash load balancer. If the
2552 # cookie is not present, it will be generated. This field is applicable if
2553 # the sessionAffinity is set to HTTP_COOKIE.
2554 #
2555 # Not supported when the backend service is referenced by a URL map that is
2556 # bound to target gRPC proxy that has validateForProxyless field set to true.
2557 # for load balancing policies that use a consistent hash.
2558 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
2559 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
2560 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
2561 # as a count of seconds and fractions of seconds at nanosecond
2562 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2563 # or &quot;month&quot;. Range is approximately 10,000 years.
2564 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2565 # Durations less than one second are represented with a 0
2566 # `seconds` field and a positive `nanos` field. Must be from 0
2567 # to 999,999,999 inclusive.
2568 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2569 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2570 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2571 },
2572 },
2573 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
2574 # applicable if the sessionAffinity is set toHEADER_FIELD.
2575 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
2576 # 1024. Larger ring sizes result in more granular load distributions. If the
2577 # number of hosts in the load balancing pool is larger than the ring size,
2578 # each host will be assigned a single virtual node.
2579 },
2580 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2581 # text format.
2582 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
2583 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
2584 # locality_lb_policy.
2585 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
2586 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2587 # long and match the regular expression
2588 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2589 # first character must be a lowercase letter, and all following
2590 # characters must be a dash, period, underscore, lowercase letter, or
2591 # digit, except the last character, which cannot be a dash, period, or
2592 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2593 # field can only be used for a global or regional backend service with the
2594 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2595 },
2596 ],
2597 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
2598 # custom
2599 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
2600 &quot;A String&quot;,
2601 ],
2602 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
2603 # custom
2604 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
2605 &quot;A String&quot;,
2606 ],
2607 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2608 # create the resource.
2609 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2610 # this backend service.
2611 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
2612 # global external Application Load Balancer.
2613 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
2614 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
2615 #
2616 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
2617 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
2618 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
2619 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
2620 # externalManagedMigrationTestingPercentage.
2621 #
2622 # Rolling back a migration requires the states to be set in reverse order. So
2623 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
2624 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
2625 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
2626 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
2627 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
2628 # external Application Load Balancer.
2629 #
2630 # The value of this field must be in the range [0, 100].
2631 #
2632 # Session affinity options will slightly affect this routing behavior, for
2633 # more details, see:Session
2634 # Affinity.
2635 #
2636 # This value can only be set if the loadBalancingScheme in the BackendService
2637 # is set to EXTERNAL (when using the classic Application Load Balancer) and
2638 # the migration state is TEST_BY_PERCENTAGE.
2639 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
2640 # as a backup (failover) backend.
2641 # For load balancers that have configurable failover:
2642 # [Internal passthrough Network Load
2643 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2644 # and [external passthrough Network Load
2645 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2646 #
2647 # failoverPolicy cannot be specified with haPolicy.
2648 # failover:
2649 # [Internal passthrough Network Load
2650 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2651 # and [external passthrough
2652 # Network Load
2653 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2654 # On failover or failback, this field indicates whether connection draining
2655 # will be honored. Google Cloud has a fixed connection draining timeout of
2656 # 10 minutes. A setting of true terminates existing TCP
2657 # connections to the active pool during failover and failback, immediately
2658 # draining traffic. A setting of false allows existing TCP
2659 # connections to persist, even on VMs no longer in the active pool, for up
2660 # to the duration of the connection draining timeout (10 minutes).
2661 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
2662 #
2663 # The default is false.
2664 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
2665 # load balancer are dropped when all primary and all backup backend VMs are
2666 # unhealthy.If set to false, connections are distributed
2667 # among all primary VMs when all primary and all backup backend VMs are
2668 # unhealthy.
2669 # For load balancers that have configurable
2670 # failover:
2671 # [Internal passthrough
2672 # Network Load
2673 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2674 # and [external passthrough
2675 # Network Load
2676 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2677 # The default is false.
2678 &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
2679 # failover when the number of healthy primary VMs equals zero.
2680 # For all other values, the load balancer performs a failover when the
2681 # total number of healthy primary VMs is less than this ratio.
2682 # For load balancers that have configurable
2683 # failover:
2684 # [Internal TCP/UDP Load
2685 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
2686 # and [external TCP/UDP Load
2687 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
2688 },
2689 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
2690 # This field is used in optimistic locking. This field will be ignored when
2691 # inserting a BackendService. An up-to-date fingerprint must be provided in
2692 # order to update the BackendService, otherwise the request will
2693 # fail with error 412 conditionNotMet.
2694 #
2695 # To see the latest fingerprint, make a get() request to
2696 # retrieve a BackendService.
2697 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
2698 # Protocol Forwarding.
2699 #
2700 # The backends of this regional backend service must only specify zonal
2701 # network endpoint groups (NEGs) of type GCE_VM_IP.
2702 #
2703 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
2704 # regional backend service must set the network field. All zonal NEGs must
2705 # belong to the same network. However, individual NEGs can
2706 # belong to different subnetworks of that network.
2707 #
2708 # When haPolicy is specified, the set of attached network endpoints across
2709 # all backends comprise an High Availability domain from which one endpoint
2710 # is selected as the active endpoint (the leader) that receives all
2711 # traffic.
2712 #
2713 # haPolicy can be added only at backend service creation time. Once set up,
2714 # it cannot be deleted.
2715 #
2716 # Note that haPolicy is not for load balancing, and therefore cannot be
2717 # specified with sessionAffinity, connectionTrackingPolicy, and
2718 # failoverPolicy.
2719 #
2720 # haPolicy requires customers to be responsible for tracking backend
2721 # endpoint health and electing a leader among the healthy endpoints.
2722 # Therefore, haPolicy cannot be specified with healthChecks.
2723 #
2724 # haPolicy can only be specified for External Passthrough Network Load
2725 # Balancers and Internal Passthrough Network Load Balancers.
2726 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
2727 # achieve it.
2728 #
2729 # Supported values are:
2730 #
2731 # - DISABLED: Fast IP Move is disabled. You can only use the
2732 # haPolicy.leader API to update the leader.
2733 # - &gt;GARP_RA: Provides a method to very quickly define a new network
2734 # endpoint as the leader. This method is faster than updating the leader
2735 # using the haPolicy.leader API. Fast IP move works as follows: The VM
2736 # hosting the network endpoint that should become the new leader sends
2737 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
2738 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
2739 # temporarily associates the forwarding rule IP address with that VM, and
2740 # both new and in-flight packets are quickly delivered to that VM.
2741 #
2742 #
2743 #
2744 # Note the important properties of the Fast IP Move functionality:
2745 #
2746 # - The GARP/RA-initiated re-routing stays active for approximately 20
2747 # minutes. After triggering fast failover, you must also
2748 # appropriately set the haPolicy.leader.
2749 # - The new leader instance should continue to send GARP/RA packets
2750 # periodically every 10 seconds until at least 10 minutes after updating
2751 # the haPolicy.leader (but stop immediately if it is no longer the leader).
2752 # - After triggering a fast failover, we recommend that you wait at least
2753 # 3 seconds before sending another GARP/RA packet from a different VM
2754 # instance to avoid race conditions.
2755 # - Don&#x27;t send GARP/RA packets from different VM
2756 # instances at the same time. If multiple instances continue to send
2757 # GARP/RA packets, traffic might be routed to different destinations in an
2758 # alternating order. This condition ceases when a single instance
2759 # issues a GARP/RA packet.
2760 # - The GARP/RA request always takes priority over the leader API.
2761 # Using the haPolicy.leader API to change the leader to a different
2762 # instance will have no effect until the GARP/RA request becomes
2763 # inactive.
2764 # - The GARP/RA packets should follow the GARP/RA
2765 # Packet Specifications..
2766 # - When multiple forwarding rules refer to a regional backend service,
2767 # you need only send a GARP or RA packet for a single forwarding rule
2768 # virtual IP. The virtual IPs for all forwarding rules targeting the same
2769 # backend service will also be moved to the sender of the GARP or RA
2770 # packet.
2771 #
2772 #
2773 #
2774 # The following are the Fast IP Move limitations (that is, when fastIPMove
2775 # is not DISABLED):
2776 #
2777 # - Multiple forwarding rules cannot use the same IP address if one of
2778 # them refers to a regional backend service with fastIPMove.
2779 # - The regional backend service must set the network field, and all
2780 # NEGs must belong to that network. However, individual
2781 # NEGs can belong to different subnetworks of that network.
2782 # - The maximum number of network endpoints across all backends of a
2783 # backend service with fastIPMove is 32.
2784 # - The maximum number of backend services with fastIPMove that can have
2785 # the same network endpoint attached to one of its backends is 64.
2786 # - The maximum number of backend services with fastIPMove in a VPC in a
2787 # region is 64.
2788 # - The network endpoints that are attached to a backend of a backend
2789 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
2790 # - Traffic directed to the leader by a static route next hop will not be
2791 # redirected to a new leader by fast failover. Such traffic will only be
2792 # redirected once an haPolicy.leader update has taken effect. Only traffic
2793 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
2794 # fast failover.
2795 #
2796 #
2797 # haPolicy.fastIPMove can be set only at backend service creation time.
2798 # Once set, it cannot be updated.
2799 #
2800 # By default, fastIpMove is set to DISABLED.
2801 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
2802 # this service as the active endpoint (the leader) that receives all
2803 # traffic.
2804 #
2805 # When the leader changes, there is no connection draining to persist
2806 # existing connections on the old leader.
2807 #
2808 # You are responsible for selecting a suitable endpoint as the
2809 # leader. For example, preferring a healthy endpoint over unhealthy ones.
2810 # Note that this service does not track backend endpoint health, and
2811 # selects the configured leader unconditionally.
2812 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
2813 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
2814 # that the leader is attached to.
2815 #
2816 # The leader&#x27;s backendGroup must already be specified as a backend of
2817 # this backend service. Removing a backend that is designated as the
2818 # leader&#x27;s backendGroup is not permitted.
2819 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
2820 # designated as the leader.
2821 #
2822 # This network endpoint cannot be detached from the NEG specified in
2823 # the haPolicy.leader.backendGroup until the leader is updated with
2824 # another network endpoint, or the leader is removed from the haPolicy.
2825 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
2826 # instance must already be attached to the NEG specified in the
2827 # haPolicy.leader.backendGroup.
2828 #
2829 # The name must be 1-63 characters long, and comply with RFC1035.
2830 # Authorization requires the following IAM permission on the
2831 # specified resource instance: compute.instances.use
2832 },
2833 },
2834 },
2835 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
2836 # httpsHealthChecks (legacy) resource for health checking this backend
2837 # service. Not all backend services support legacy health checks. See
2838 # Load balancer guide. Currently, at most one health check can be
2839 # specified for each backend service. Backend services with
2840 # instance group or zonal NEG backends must have a health check unless
2841 # haPolicy is specified. Backend services with internet or serverless NEG
2842 # backends must not have a health check.
2843 #
2844 # healthChecks[] cannot be specified with haPolicy.
2845 &quot;A String&quot;,
2846 ],
2847 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
2848 # Not available for internal passthrough Network Load Balancers and external
2849 # passthrough Network Load Balancers.
2850 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
2851 # incoming requests.
2852 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
2853 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
2854 # For security reasons, this value cannot be retrieved via the API.
2855 # Instead, the SHA-256 hash of the value is returned in the
2856 # oauth2ClientSecretSha256 field.
2857 #
2858 # @InputOnly
2859 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
2860 },
2861 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2862 # defined by the server.
2863 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
2864 # from the client to the backend for proxyless gRPC).
2865 # The possible values are:
2866 #
2867 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
2868 # backend service (Instance Group, Managed Instance Group, Network Endpoint
2869 # Group), regardless of traffic from the client to the proxy. Only IPv4
2870 # health checks are used to check the health of the backends. This is the
2871 # default setting.
2872 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
2873 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
2874 # address).
2875 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
2876 # backend service (Instance Group, Managed Instance Group, Network Endpoint
2877 # Group), regardless of traffic from the client to the proxy. Only IPv6
2878 # health checks are used to check the health of the backends.
2879 #
2880 #
2881 #
2882 # This field is applicable to either:
2883 #
2884 # - Advanced global external Application Load Balancer (load balancing
2885 # scheme EXTERNAL_MANAGED),
2886 # - Regional external Application Load
2887 # Balancer,
2888 # - Internal proxy Network Load Balancer (load balancing
2889 # scheme INTERNAL_MANAGED),
2890 # - Regional internal Application Load
2891 # Balancer (load balancing scheme INTERNAL_MANAGED),
2892 # - Traffic
2893 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
2894 # INTERNAL_SELF_MANAGED).
2895 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
2896 # for backend services.
2897 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
2898 # created for one type of load balancer cannot be used with another.
2899 # For more information, refer toChoosing
2900 # a load balancer.
2901 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
2902 # preference. When you use localityLbPolicies, you must set at least one
2903 # value for either the localityLbPolicies[].policy or the
2904 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
2905 # value set in the localityLbPolicy field.
2906 #
2907 # For an example of how to use this field, seeDefine
2908 # a list of preferred policies.
2909 #
2910 # Caution: This field and its children are intended for use in a service mesh
2911 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
2912 # that have this configuration.
2913 { # Container for either a built-in LB policy supported by gRPC or Envoy or
2914 # a custom one implemented by the end user.
2915 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
2916 # deployed with the client.
2917 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
2918 # by a locally installed custom policy implementation.
2919 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
2920 #
2921 # The value should match the name of a custom implementation registered
2922 # on the gRPC clients. It should follow protocol buffer message naming
2923 # conventions and include the full path (for example,
2924 # myorg.CustomLbPolicy). The maximum length is 256 characters.
2925 #
2926 # Do not specify the same custom policy more than once for a
2927 # backend. If you do, the configuration is rejected.
2928 #
2929 # For an example of how to use this field, seeUse
2930 # a custom policy.
2931 },
2932 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
2933 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
2934 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
2935 # about these values, see the description of localityLbPolicy.
2936 #
2937 # Do not specify the same policy more than once for a
2938 # backend. If you do, the configuration is rejected.
2939 },
2940 },
2941 ],
2942 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
2943 # possible values are:
2944 #
2945 # - ROUND_ROBIN: This is a simple policy in which each healthy
2946 # backend is selected in round robin order. This is the default.
2947 # - LEAST_REQUEST: An O(1) algorithm which
2948 # selects two random healthy hosts and picks the host which has fewer active
2949 # requests.
2950 # - RING_HASH: The ring/modulo hash load balancer implements
2951 # consistent hashing to backends. The algorithm has the property that the
2952 # addition/removal of a host from a set of N hosts only affects 1/N of the
2953 # requests.
2954 # - RANDOM: The load balancer selects a random healthy
2955 # host.
2956 # - ORIGINAL_DESTINATION: Backend host is selected
2957 # based on the client connection metadata, i.e., connections are opened to
2958 # the same address as the destination address of the incoming connection
2959 # before the connection was redirected to the load balancer.
2960 # - MAGLEV: used as a drop in replacement for the ring hash
2961 # load balancer. Maglev is not as stable as ring hash but has faster table
2962 # lookup build times and host selection times. For more information about
2963 # Maglev, see Maglev:
2964 # A Fast and Reliable Software Network Load Balancer.
2965 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
2966 # Load Balancing using weights computed from Backend reported Custom Metrics.
2967 # If set, the Backend Service responses are expected to contain non-standard
2968 # HTTP response header field Endpoint-Load-Metrics. The reported
2969 # metrics to use for computing the weights are specified via thecustomMetrics field.
2970 #
2971 # This field is applicable to either:
2972 # - A regional backend service with the service protocol set to HTTP,
2973 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
2974 # INTERNAL_MANAGED.
2975 # - A global backend service with the
2976 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
2977 # EXTERNAL_MANAGED.
2978 #
2979 #
2980 # If sessionAffinity is not configured—that is, if session
2981 # affinity remains at the default value of NONE—then the
2982 # default value for localityLbPolicy
2983 # is ROUND_ROBIN. If session affinity is set to a value other
2984 # than NONE,
2985 # then the default value for localityLbPolicy isMAGLEV.
2986 #
2987 # Only ROUND_ROBIN and RING_HASH are supported
2988 # when the backend service is referenced by a URL map that is bound to
2989 # target gRPC proxy that has validateForProxyless field set to true.
2990 #
2991 # localityLbPolicy cannot be specified with haPolicy.
2992 &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
2993 # by this backend service. If logging is enabled, logs will be exported to
2994 # Stackdriver.
2995 # backend service.
2996 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
2997 # traffic served by this backend service. The default value is false.
2998 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
2999 { # Determines which HTTP headers will be logged to Stackdriver.
3000 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3001 },
3002 ],
3003 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
3004 { # Determines which HTTP headers will be logged to Stackdriver.
3005 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3006 },
3007 ],
3008 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
3009 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
3010 # of optional fields you want to include in the logs. For example:
3011 # serverInstance, serverGkeDetails.cluster,
3012 # serverGkeDetails.pod.podNamespace
3013 &quot;A String&quot;,
3014 ],
3015 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
3016 # service. Configures whether all, none or a subset of optional fields
3017 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3018 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3019 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
3020 # service. The value of the field must be in [0, 1]. This configures the
3021 # sampling rate of requests to the load balancer where 1.0 means all logged
3022 # requests are reported and 0.0 means no logged requests are reported. The
3023 # default value is 1.0.
3024 },
3025 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
3026 # service. Duration is computed from the beginning of the stream until the
3027 # response has been completely processed, including all retries. A stream
3028 # that does not complete in this duration is closed.
3029 #
3030 # If not specified, there will be no timeout limit, i.e. the maximum
3031 # duration is infinite.
3032 #
3033 # This value can be overridden in the PathMatcher configuration of the
3034 # UrlMap that references this backend service.
3035 #
3036 # This field is only allowed when the loadBalancingScheme of
3037 # the backend service is INTERNAL_SELF_MANAGED.
3038 # as a count of seconds and fractions of seconds at nanosecond
3039 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3040 # or &quot;month&quot;. Range is approximately 10,000 years.
3041 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3042 # Durations less than one second are represented with a 0
3043 # `seconds` field and a positive `nanos` field. Must be from 0
3044 # to 999,999,999 inclusive.
3045 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3046 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3047 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3048 },
3049 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
3050 # controller and read by the backend RCTH
3051 &quot;a_key&quot;: &quot;A String&quot;,
3052 },
3053 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3054 # The name must be 1-63 characters long, and comply withRFC1035.
3055 # Specifically, the name must be 1-63 characters long and match the regular
3056 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3057 # character must be a lowercase letter, and all following characters must
3058 # be a dash, lowercase letter, or digit, except the last character, which
3059 # cannot be a dash.
3060 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
3061 #
3062 # This field must be set for Internal Passthrough Network Load Balancers when
3063 # the haPolicy is enabled, and for External Passthrough Network Load
3064 # Balancers when the haPolicy fastIpMove is enabled.
3065 #
3066 # 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.
3067 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
3068 # Load Balancers.
3069 #
3070 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
3071 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
3072 # endpoints in the local zone.
3073 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
3074 # possible values are:
3075 #
3076 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
3077 # is disabled. The load balancer distributes new connections to all
3078 # healthy backend endpoints across all zones.
3079 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
3080 # enabled. The load balancer distributes new connections to all healthy
3081 # backend endpoints in the local zone only. If there are no healthy
3082 # backend endpoints in the local zone, the load balancer distributes
3083 # new connections to all backend endpoints in the local zone.
3084 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
3085 # enabled. The load balancer distributes new connections to all healthy
3086 # backend endpoints in the local zone only. If there aren&#x27;t enough
3087 # healthy backend endpoints in the local zone, the load balancer
3088 # distributes new connections to all healthy backend endpoints across all
3089 # zones.
3090 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
3091 # of healthy backend endpoints in a zone to the count of backend
3092 # endpoints in that same zone is equal to or above this threshold, the
3093 # load balancer distributes new connections to all healthy endpoints in
3094 # the local zone only. When the ratio of the count of healthy backend
3095 # endpoints in a zone to the count of backend endpoints in that same
3096 # zone is below this threshold, the load balancer distributes all new
3097 # connections to all healthy endpoints across all zones.
3098 },
3099 },
3100 &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.
3101 # the backend service.
3102 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
3103 # service.
3104 },
3105 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
3106 # load balancing pool of each individual proxy instance that processes the
3107 # traffic for the given backend service. If not set, this feature is
3108 # considered disabled.
3109 #
3110 # Results of the outlier detection algorithm (ejection of endpoints from the
3111 # load balancing pool and returning them back to the pool) are executed
3112 # independently by each proxy instance of the load balancer. In most cases,
3113 # more than one proxy instance handles the traffic received by a backend
3114 # service. Thus, it is possible that an unhealthy endpoint is detected and
3115 # ejected by only some of the proxies, and while this happens, other proxies
3116 # may continue to send requests to the same unhealthy endpoint until they
3117 # detect and eject the unhealthy endpoint.
3118 #
3119 # Applicable backend endpoints can be:
3120 #
3121 # - VM instances in an Instance Group
3122 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
3123 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
3124 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
3125 # Functions Services
3126 # - Private Service Connect NEGs, that resolve to
3127 # Google-managed regional API endpoints or managed services published using
3128 # Private Service Connect
3129 #
3130 #
3131 #
3132 # Applicable backend service types can be:
3133 #
3134 # - A global backend service with the loadBalancingScheme set to
3135 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
3136 # - A regional backend
3137 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
3138 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
3139 # supported for Serverless NEGs.
3140 #
3141 #
3142 #
3143 # Not supported when the backend service is referenced by a URL map that is
3144 # bound to target gRPC proxy that has validateForProxyless field set to true.
3145 # pool for the backend service.
3146 &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
3147 # or 30s.
3148 #
3149 # After a backend endpoint is returned back to the load balancing pool, it
3150 # can be ejected again in another ejection analysis. Thus, the total ejection
3151 # time is equal to the base ejection time multiplied by the number of times
3152 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
3153 # as a count of seconds and fractions of seconds at nanosecond
3154 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3155 # or &quot;month&quot;. Range is approximately 10,000 years.
3156 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3157 # Durations less than one second are represented with a 0
3158 # `seconds` field and a positive `nanos` field. Must be from 0
3159 # to 999,999,999 inclusive.
3160 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3161 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3162 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3163 },
3164 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
3165 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
3166 # return code qualifies as an error. Defaults to 5.
3167 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
3168 # connection errors that are mapped to one of those status codes) before a
3169 # consecutive gateway failure ejection occurs. Defaults to 3.
3170 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3171 # outlier status is detected through consecutive 5xx. This setting can be
3172 # used to disable ejection or to ramp it up slowly. Defaults to 0.
3173 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3174 # outlier status is detected through consecutive gateway failures. This
3175 # setting can be used to disable ejection or to ramp it up slowly. Defaults
3176 # to 100.
3177 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3178 # outlier status is detected through success rate statistics. This setting
3179 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
3180 #
3181 # Not supported when the backend service uses Serverless NEG.
3182 &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
3183 # ejections and backend endpoints being returned to service. The interval is
3184 # equal to the number of seconds as defined in
3185 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
3186 # in outlierDetection.interval.nanos. Defaults to 1 second.
3187 # as a count of seconds and fractions of seconds at nanosecond
3188 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3189 # or &quot;month&quot;. Range is approximately 10,000 years.
3190 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3191 # Durations less than one second are represented with a 0
3192 # `seconds` field and a positive `nanos` field. Must be from 0
3193 # to 999,999,999 inclusive.
3194 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3195 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3196 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3197 },
3198 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
3199 # backend service that can be ejected if the ejection conditions are met.
3200 # Defaults to 50%.
3201 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
3202 # enough request volume to detect success rate outliers. If the number of
3203 # backend endpoints is fewer than this setting, outlier detection via success
3204 # rate statistics is not performed for any backend endpoint in the load
3205 # balancing pool. Defaults to 5.
3206 #
3207 # Not supported when the backend service uses Serverless NEG.
3208 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
3209 # (as defined by the interval duration above) to include this backend
3210 # endpoint in success rate based outlier detection. If the volume is lower
3211 # than this setting, outlier detection via success rate statistics is not
3212 # performed for that backend endpoint. Defaults to 100.
3213 #
3214 # Not supported when the backend service uses Serverless NEG.
3215 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
3216 # outlier ejection. The ejection threshold is the difference between the mean
3217 # success rate, and the product of this factor and the standard deviation of
3218 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
3219 # is divided by a thousand to get a double. That is, if the desired factor
3220 # is 1.9, the runtime value should be 1900. Defaults to 1900.
3221 #
3222 # Not supported when the backend service uses Serverless NEG.
3223 },
3224 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3225 # as part of resource payload.
3226 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3227 # Tag keys and values have the same definition as resource
3228 # manager tags. The field is allowed for INSERT
3229 # only. The keys/values to set on the resource should be specified in
3230 # either ID { : } or Namespaced format
3231 # { : }.
3232 # For example the following are valid inputs:
3233 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3234 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3235 # Note:
3236 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3237 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3238 &quot;a_key&quot;: &quot;A String&quot;,
3239 },
3240 },
3241 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
3242 # the backend. The default value is 80.
3243 # For internal passthrough Network Load Balancers and external passthrough
3244 # Network Load Balancers, omit port.
3245 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
3246 # communication to the backend VMs in that group. The
3247 # named port must be [defined on each backend instance
3248 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
3249 # This parameter has no meaning if the backends are NEGs. For internal
3250 # passthrough Network Load Balancers and external passthrough Network Load
3251 # Balancers, omit port_name.
3252 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
3253 # with backends.
3254 #
3255 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
3256 # depending on the chosen load balancer or Traffic Director configuration.
3257 # Refer to the documentation for the load balancers or for Traffic Director
3258 # for more information.
3259 #
3260 # Must be set to GRPC when the backend service is referenced by a URL map
3261 # that is bound to target gRPC proxy.
3262 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
3263 # resides. This field is not applicable to global backend services.
3264 # You must specify this field as part of the HTTP request URL. It is
3265 # not settable as a field in the request body.
3266 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
3267 # backend service.
3268 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
3269 # service. This field is applicable to a global backend service with the
3270 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3271 &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
3272 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
3273 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
3274 # private storage buckets that support Signature Version 4 for authentication.
3275 # The service name for generating the authentication header will always default
3276 # to &#x27;s3&#x27;.
3277 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
3278 # creating a backend that uses AWS v4 signature authentication, but will not
3279 # be returned as part of the configuration when queried with a REST API GET
3280 # request.
3281 #
3282 # @InputOnly
3283 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
3284 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
3285 # keep track of different iterations of your access key.
3286 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
3287 # the name of the region your cloud uses to host your origin. For example,
3288 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
3289 },
3290 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
3291 # that describes how clients should authenticate with this service&#x27;s
3292 # backends.
3293 #
3294 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
3295 # to INTERNAL_SELF_MANAGED.
3296 #
3297 # If left blank, communications are not encrypted.
3298 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
3299 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
3300 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
3301 # specified values, the communication continues. Otherwise, it fails. This
3302 # additional check enables the client to verify that the server is authorized
3303 # to run the requested service.
3304 #
3305 # Note that the contents of the server
3306 # certificate&#x27;s subjectAltName field are configured by the
3307 # Public Key Infrastructure which provisions server identities.
3308 #
3309 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
3310 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
3311 # mode).
3312 &quot;A String&quot;,
3313 ],
3314 },
3315 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3316 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
3317 #
3318 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
3319 # If set, lists of backends and health checks must be both empty.
3320 &quot;A String&quot;,
3321 ],
3322 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
3323 #
3324 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
3325 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
3326 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
3327 #
3328 # Only NONE and HEADER_FIELD are supported
3329 # when the backend service is referenced by a URL map that is bound to
3330 # target gRPC proxy that has validateForProxyless field set to true.
3331 #
3332 # For more details, see:
3333 # [Session
3334 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
3335 #
3336 # sessionAffinity cannot be specified with haPolicy.
3337 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
3338 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
3339 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3340 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3341 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3342 # as a count of seconds and fractions of seconds at nanosecond
3343 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3344 # or &quot;month&quot;. Range is approximately 10,000 years.
3345 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3346 # Durations less than one second are represented with a 0
3347 # `seconds` field and a positive `nanos` field. Must be from 0
3348 # to 999,999,999 inclusive.
3349 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3350 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3351 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3352 },
3353 },
3354 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
3355 # Currently this is applicable only for Internal TCP/UDP load balancing,
3356 # Internal HTTP(S) load balancing and Traffic Director.
3357 &quot;policy&quot;: &quot;A String&quot;,
3358 },
3359 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
3360 # type of load balancer. For more information see,
3361 # Backend service settings.
3362 # The default is 30 seconds.
3363 # The full range of timeout values allowed goes from 1
3364 # through 2,147,483,647 seconds.
3365 #
3366 # This value can be overridden in the PathMatcher configuration of the
3367 # UrlMap that references this backend service.
3368 #
3369 # Not supported when the backend service is referenced by a URL map that is
3370 # bound to target gRPC proxy that has validateForProxyless field set to true.
3371 # Instead, use maxStreamDuration.
3372 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
3373 # when the backend protocol is SSL, HTTPS or HTTP2.
3374 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
3375 # networksecurity.googleapis.com namespace. Can be used in authenticating
3376 # TLS connections to the backend, as specified by the authenticationMode
3377 # field. Can only be specified if authenticationMode is not NONE.
3378 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
3379 # balancer sends this string as the SNI hostname in the TLS connection to
3380 # the backend, and requires that this string match a Subject Alternative
3381 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
3382 # NEG backend, if the SNI is specified here, the load balancer uses it
3383 # regardless of whether the Regional Internet NEG is specified with FQDN or
3384 # IP address and port. When both sni and subjectAltNames[] are specified,
3385 # the load balancer matches the backend certificate&#x27;s SAN only to
3386 # subjectAltNames[].
3387 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
3388 # verifies during a TLS handshake with the backend. When the server
3389 # presents its X.509 certificate to the Load Balancer, the Load Balancer
3390 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
3391 # match one of the subjectAltNames in the list. This field is limited to 5
3392 # entries. When both sni and subjectAltNames[] are specified, the load
3393 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
3394 { # A Subject Alternative Name that the load balancer matches against the SAN
3395 # field in the TLS certificate provided by the backend, specified as either
3396 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
3397 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
3398 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
3399 },
3400 ],
3401 },
3402 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
3403 {
3404 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
3405 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
3406 # and ForwardingRule.
3407 },
3408 ],
3409 }
3410
3411 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3412 that if you must retry your request, the server will know to ignore the
3413 request if it has already been completed.
3414
3415 For example, consider a situation where you make an initial request and
3416 the request times out. If you make the request again with the same
3417 request ID, the server can check if original operation with the same
3418 request ID was received, and if so, will ignore the second request. This
3419 prevents clients from accidentally creating duplicate commitments.
3420
3421 The request ID must be
3422 a valid UUID with the exception that zero UUID is not supported
3423 (00000000-0000-0000-0000-000000000000).
3424 x__xgafv: string, V1 error format.
3425 Allowed values
3426 1 - v1 error format
3427 2 - v2 error format
3428
3429 Returns:
3430 An object of the form:
3431
3432 { # Represents an Operation resource.
3433 #
3434 # Google Compute Engine has three Operation resources:
3435 #
3436 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3437 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3438 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3439 #
3440 # You can use an operation resource to manage asynchronous API requests.
3441 # For more information, readHandling
3442 # API responses.
3443 #
3444 # Operations can be global, regional or zonal.
3445 #
3446 # - For global operations, use the `globalOperations`
3447 # resource.
3448 # - For regional operations, use the
3449 # `regionOperations` resource.
3450 # - For zonal operations, use
3451 # the `zoneOperations` resource.
3452 #
3453 #
3454 #
3455 # For more information, read
3456 # Global, Regional, and Zonal Resources.
3457 #
3458 # Note that completed Operation resources have a limited
3459 # retention period.
3460 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3461 # Not present otherwise.
3462 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3463 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3464 # set when the operation is created.
3465 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3466 # text format.
3467 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3468 # this field will be populated.
3469 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3470 # operation.
3471 {
3472 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3473 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3474 # details. There is a set of defined message types to use for providing
3475 # details.The syntax depends on the error code. For example,
3476 # QuotaExceededInfo will have details when the error code is
3477 # QUOTA_EXCEEDED.
3478 {
3479 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3480 #
3481 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3482 # is not enabled:
3483 #
3484 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3485 # &quot;domain&quot;: &quot;googleapis.com&quot;
3486 # &quot;metadata&quot;: {
3487 # &quot;resource&quot;: &quot;projects/123&quot;,
3488 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3489 # }
3490 # }
3491 #
3492 # This response indicates that the pubsub.googleapis.com API is not enabled.
3493 #
3494 # Example of an error that is returned when attempting to create a Spanner
3495 # instance in a region that is out of stock:
3496 #
3497 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3498 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3499 # &quot;metadata&quot;: {
3500 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3501 # }
3502 # }
3503 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3504 # is typically the registered service name of the tool or product that
3505 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3506 # generated by some common infrastructure, the error domain must be a
3507 # globally unique value that identifies the infrastructure. For Google API
3508 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3509 &quot;metadatas&quot;: { # Additional structured details about this error.
3510 #
3511 # Keys must match a regular expression of `a-z+` but should
3512 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3513 # length. When identifying the current value of an exceeded limit, the units
3514 # should be contained in the key, not the value. For example, rather than
3515 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3516 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3517 # instances that can be created in a single (batch) request.
3518 &quot;a_key&quot;: &quot;A String&quot;,
3519 },
3520 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3521 # proximate cause of the error. Error reasons are unique within a particular
3522 # domain of errors. This should be at most 63 characters and match a
3523 # regular expression of `A-Z+[A-Z0-9]`, which represents
3524 # UPPER_SNAKE_CASE.
3525 },
3526 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3527 #
3528 # For example, if a quota check failed with an error indicating the calling
3529 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3530 # directly to the right place in the developer console to flip the bit.
3531 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3532 { # Describes a URL link.
3533 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3534 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3535 },
3536 ],
3537 },
3538 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3539 # which can be attached to an RPC error.
3540 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3541 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3542 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3543 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3544 },
3545 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3546 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3547 &quot;a_key&quot;: &quot;A String&quot;,
3548 },
3549 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3550 # type or metric.
3551 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3552 # or metric.
3553 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3554 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3555 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3556 },
3557 },
3558 ],
3559 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3560 # This property is optional.
3561 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3562 },
3563 ],
3564 },
3565 &quot;getVersionOperationMetadata&quot;: {
3566 &quot;inlineSbomInfo&quot;: {
3567 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3568 # appropriate identifiers.
3569 &quot;a_key&quot;: &quot;A String&quot;,
3570 },
3571 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3572 # identifiers.
3573 &quot;a_key&quot;: &quot;A String&quot;,
3574 },
3575 },
3576 },
3577 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3578 # message that was returned, such as `NOT FOUND`.
3579 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3580 # status code that was returned. For example, a `404` means the
3581 # resource was not found.
3582 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3583 # defined by the server.
3584 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3585 # This value is inRFC3339
3586 # text format.
3587 &quot;instancesBulkInsertOperationMetadata&quot;: {
3588 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3589 # Example key: zones/us-central1-a
3590 &quot;a_key&quot;: {
3591 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3592 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3593 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3594 # error.
3595 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3596 # if the flow is rolling forward or rolling back.
3597 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3598 },
3599 },
3600 },
3601 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3602 # Operation resources.
3603 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3604 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3605 # group of operations results from a `bulkInsert` API request.
3606 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3607 # `update`, or `delete`, and so on.
3608 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3609 # There is no requirement that this be linear or support any granularity of
3610 # operations. This should not be used to guess when the operation will be
3611 # complete. This number should monotonically increase as the operation
3612 # progresses.
3613 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3614 # applicable when performing regional operations.
3615 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3616 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3617 # this field will contain information on all underlying zonal actions and
3618 # their state.
3619 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3620 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3621 # Example key: zones/us-central1-a
3622 &quot;a_key&quot;: {
3623 &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
3624 # populated.
3625 # different programming environments, including REST APIs and RPC APIs. It is
3626 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3627 # three pieces of data: error code, error message, and error details.
3628 #
3629 # You can find out more about this error model and how to work with it in the
3630 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3631 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3632 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3633 # message types for APIs to use.
3634 {
3635 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3636 },
3637 ],
3638 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3639 # user-facing error message should be localized and sent in the
3640 # google.rpc.Status.details field, or localized by the client.
3641 },
3642 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3643 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3644 },
3645 },
3646 },
3647 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3648 # This value is inRFC3339
3649 # text format.
3650 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3651 # following:
3652 # `PENDING`, `RUNNING`, or `DONE`.
3653 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3654 # operation.
3655 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3656 # of the target resource.
3657 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3658 # operations related to creating a snapshot, this points to the disk
3659 # that the snapshot was created from.
3660 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3661 # `[email protected]` or
3662 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3663 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3664 # operation, this field will be populated.
3665 {
3666 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3667 # Engine returns NO_RESULTS_ON_PAGE if there
3668 # are no results in the response.
3669 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3670 # value format. For example:
3671 #
3672 # &quot;data&quot;: [
3673 # {
3674 # &quot;key&quot;: &quot;scope&quot;,
3675 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3676 # }
3677 {
3678 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3679 # returned. For example, for warnings where there are no results in a list
3680 # request for a particular zone, this key might be scope and
3681 # the key value might be the zone name. Other examples might be a key
3682 # indicating a deprecated resource and a suggested replacement, or a
3683 # warning about invalid network settings (for example, if an instance
3684 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3685 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3686 },
3687 ],
3688 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3689 },
3690 ],
3691 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3692 # applicable when performing per-zone operations.
3693 }</pre>
3694 </div>
3695
3696 <div class="method">
3697 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
3698 <pre>Retrieves the list of regional BackendService resources available to the
3699 specified project in the given region.
3700
3701 Args:
3702 project: string, Project ID for this request. (required)
3703 region: string, Name of the region scoping this request. (required)
3704 filter: string, A filter expression that filters resources listed in the response. Most
3705 Compute resources support two types of filter expressions:
3706 expressions that support regular expressions and expressions that follow
3707 API improvement proposal AIP-160.
3708 These two types of filter expressions cannot be mixed in one request.
3709
3710 If you want to use AIP-160, your expression must specify the field name, an
3711 operator, and the value that you want to use for filtering. The value
3712 must be a string, a number, or a boolean. The operator
3713 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3714
3715 For example, if you are filtering Compute Engine instances, you can
3716 exclude instances named `example-instance` by specifying
3717 `name != example-instance`.
3718
3719 The `:*` comparison can be used to test whether a key has been defined.
3720 For example, to find all objects with `owner` label use:
3721 ```
3722 labels.owner:*
3723 ```
3724
3725 You can also filter nested fields. For example, you could specify
3726 `scheduling.automaticRestart = false` to include instances only
3727 if they are not scheduled for automatic restarts. You can use filtering
3728 on nested fields to filter based onresource labels.
3729
3730 To filter on multiple expressions, provide each separate expression within
3731 parentheses. For example:
3732 ```
3733 (scheduling.automaticRestart = true)
3734 (cpuPlatform = &quot;Intel Skylake&quot;)
3735 ```
3736 By default, each expression is an `AND` expression. However, you
3737 can include `AND` and `OR` expressions explicitly.
3738 For example:
3739 ```
3740 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3741 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3742 (scheduling.automaticRestart = true)
3743 ```
3744
3745 If you want to use a regular expression, use the `eq` (equal) or `ne`
3746 (not equal) operator against a single un-parenthesized expression with or
3747 without quotes or against multiple parenthesized expressions. Examples:
3748
3749 `fieldname eq unquoted literal`
3750 `fieldname eq &#x27;single quoted literal&#x27;`
3751 `fieldname eq &quot;double quoted literal&quot;`
3752 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3753
3754 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3755 The literal value must match the entire field.
3756
3757 For example, to filter for instances that do not end with name &quot;instance&quot;,
3758 you would use `name ne .*instance`.
3759
3760 You cannot combine constraints on multiple fields using regular
3761 expressions.
3762 maxResults: integer, The maximum number of results per page that should be returned.
3763 If the number of available results is larger than `maxResults`,
3764 Compute Engine returns a `nextPageToken` that can be used to get
3765 the next page of results in subsequent list requests. Acceptable values are
3766 `0` to `500`, inclusive. (Default: `500`)
3767 orderBy: string, Sorts list results by a certain order. By default, results
3768 are returned in alphanumerical order based on the resource name.
3769
3770 You can also sort results in descending order based on the creation
3771 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3772 results based on the `creationTimestamp` field in
3773 reverse chronological order (newest result first). Use this to sort
3774 resources like operations so that the newest operation is returned first.
3775
3776 Currently, only sorting by `name` or
3777 `creationTimestamp desc` is supported.
3778 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3779 `nextPageToken` returned by a previous list request to get
3780 the next page of results.
3781 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3782 of failure. The default value is false.
3783
3784 For example, when partial success behavior is enabled, aggregatedList for a
3785 single zone scope either returns all resources in the zone or no resources,
3786 with an error code.
3787 x__xgafv: string, V1 error format.
3788 Allowed values
3789 1 - v1 error format
3790 2 - v2 error format
3791
3792 Returns:
3793 An object of the form:
3794
3795 { # Contains a list of BackendService resources.
3796 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3797 &quot;items&quot;: [ # A list of BackendService resources.
3798 { # Represents a Backend Service resource.
3799 #
3800 # A backend service defines how Google Cloud load balancers distribute traffic.
3801 # The backend service configuration contains a set of values, such as the
3802 # protocol used to connect to backends, various distribution and session
3803 # settings, health checks, and timeouts. These settings provide fine-grained
3804 # control over how your load balancer behaves. Most of the settings have
3805 # default values that allow for easy configuration if you need to get started
3806 # quickly.
3807 #
3808 # Backend services in Google Compute Engine can be either regionally or
3809 # globally scoped.
3810 #
3811 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
3812 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
3813 #
3814 # For more information, seeBackend
3815 # Services.
3816 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
3817 # Load Balancers and Traffic Director and requires
3818 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
3819 #
3820 # If set to 0, the cookie is non-persistent and lasts only until
3821 # the end of the browser session (or equivalent). The maximum allowed value
3822 # is two weeks (1,209,600).
3823 #
3824 # Not supported when the backend service is referenced by a URL map that is
3825 # bound to target gRPC proxy that has validateForProxyless field set to true.
3826 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
3827 { # Message containing information of one individual backend.
3828 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
3829 # handle additional traffic or is fully loaded. For usage guidelines, see
3830 # Connection balancing mode.
3831 #
3832 # Backends must use compatible balancing modes. For more information, see
3833 # Supported balancing modes and target capacity settings and
3834 # Restrictions and guidance for instance groups.
3835 #
3836 # Note: Currently, if you use the API to configure incompatible balancing
3837 # modes, the configuration might be accepted even though it has no impact
3838 # and is ignored. Specifically, Backend.maxUtilization is ignored when
3839 # Backend.balancingMode is RATE. In the future, this incompatible combination
3840 # will be rejected.
3841 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
3842 # mode.
3843 # The default value is 1, which means the group serves up to
3844 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
3845 # completely drained, offering 0% of its available capacity. The valid ranges
3846 # are 0.0 and [0.1,1.0].
3847 # You cannot configure a setting larger than 0 and smaller than0.1.
3848 # You cannot configure a setting of 0 when there is only one
3849 # backend attached to the backend service.
3850 #
3851 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
3852 # internet NEGs, regional serverless NEGs, and PSC NEGs.
3853 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
3854 # BalancingMode.
3855 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
3856 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
3857 # Monitoring, but is not used for load balancing.
3858 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
3859 # balancing mode. The valid range is [0.0, 1.0].
3860 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
3861 # long and match the regular expression
3862 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
3863 # first character must be a lowercase letter, and all following
3864 # characters must be a dash, period, underscore, lowercase letter, or
3865 # digit, except the last character, which cannot be a dash, period, or
3866 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
3867 # field can only be used for a global or regional backend service with the
3868 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
3869 },
3870 ],
3871 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3872 # create the resource.
3873 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
3874 # failover backend can be configured for a given BackendService.
3875 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
3876 # group or network endpoint
3877 # group (NEG) resource. To determine what types of backends a load
3878 # balancer supports, see the [Backend services
3879 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
3880 #
3881 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
3882 # or NEG. Partial URLs are not supported.
3883 #
3884 # If haPolicy is specified, backends must refer to NEG resources of type
3885 # GCE_VM_IP.
3886 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
3887 # guidelines, seeConnection
3888 # balancing mode and Utilization
3889 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
3890 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
3891 # guidelines, seeConnection
3892 # balancing mode and Utilization
3893 # balancing mode.
3894 #
3895 # Not available if the backend&#x27;s balancingMode isRATE.
3896 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
3897 # For usage guidelines, seeConnection
3898 # balancing mode and Utilization
3899 # balancing mode.
3900 #
3901 # Not available if the backend&#x27;s balancingMode isRATE.
3902 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
3903 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
3904 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
3905 # Not available if backend&#x27;s balancingMode is RATE
3906 # or CONNECTION.
3907 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
3908 # Not available if backend&#x27;s balancingMode is RATE
3909 # or CONNECTION.
3910 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
3911 # usage guidelines, seeRate
3912 # balancing mode and Utilization
3913 # balancing mode.
3914 #
3915 # Not available if the backend&#x27;s balancingMode isCONNECTION.
3916 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
3917 # guidelines, seeRate
3918 # balancing mode and Utilization
3919 # balancing mode.
3920 #
3921 # Not available if the backend&#x27;s balancingMode isCONNECTION.
3922 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
3923 # guidelines, seeRate
3924 # balancing mode and Utilization
3925 # balancing mode.
3926 #
3927 # Not available if the backend&#x27;s balancingMode isCONNECTION.
3928 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
3929 #
3930 # For usage guidelines, seeUtilization
3931 # balancing mode.
3932 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
3933 # the backend.
3934 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
3935 },
3936 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
3937 # sending traffic to backends with default preference. The possible values
3938 # are:
3939 #
3940 # - PREFERRED: Backends with this preference level will be
3941 # filled up to their capacity limits first, based on RTT.
3942 # - DEFAULT: If preferred backends don&#x27;t have enough
3943 # capacity, backends in this layer would be used and traffic would be
3944 # assigned based on the load balancing algorithm you use. This is the
3945 # default
3946 &quot;trafficDuration&quot;: &quot;A String&quot;,
3947 },
3948 ],
3949 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
3950 # specified load balancer types.
3951 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
3952 # Pragma or Authorization headers. Up to 5 headers can be specified.
3953 # The cache is bypassed for all cdnPolicy.cacheMode settings.
3954 { # Bypass the cache when the specified request headers are present,
3955 # e.g. Pragma or Authorization headers. Values are case insensitive.
3956 # The presence of such a header overrides the cache_mode setting.
3957 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
3958 # Values are case-insensitive.
3959 },
3960 ],
3961 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
3962 # CDN.
3963 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
3964 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
3965 &quot;A String&quot;,
3966 ],
3967 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
3968 # The name=value pair will be used in the cache key Cloud CDN generates.
3969 &quot;A String&quot;,
3970 ],
3971 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
3972 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
3973 # query_string_whitelist and query_string_blacklist. If neither is set, the
3974 # entire query string will be included. If false, the query string will be
3975 # excluded from the cache key entirely.
3976 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
3977 # parameters will be included. Either specify query_string_whitelist or
3978 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
3979 # not treated as delimiters.
3980 &quot;A String&quot;,
3981 ],
3982 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
3983 # parameters will be excluded. Either specify query_string_whitelist or
3984 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
3985 # not treated as delimiters.
3986 &quot;A String&quot;,
3987 ],
3988 },
3989 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
3990 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
3991 # headers to cache content. Responses without these headers will not be
3992 # cached at Google&#x27;s edge, and will require a full trip to the origin on
3993 # every request, potentially impacting performance and increasing load on
3994 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
3995 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
3996 # Warning: this may result in Cloud CDN caching private,
3997 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
3998 # including common image formats, media (video and audio), and web assets
3999 # (JavaScript and CSS). Requests and responses that are marked as
4000 # uncacheable, as well as dynamic content (including HTML), will not be
4001 # cached.
4002 #
4003 # If no value is provided for cdnPolicy.cacheMode, it defaults
4004 # to CACHE_ALL_STATIC.
4005 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
4006 # used to clamp the max-age (or Expires) value sent to the client. With
4007 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
4008 # response max-age directive, along with a &quot;public&quot; directive. For
4009 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
4010 # from the origin (if specified), or else sets the response max-age
4011 # directive to the lesser of the client_ttl and default_ttl, and also
4012 # ensures a &quot;public&quot; cache-control directive is present.
4013 # If a client TTL is not specified, a default value (1 hour) will be used.
4014 # The maximum allowed value is 31,622,400s (1 year).
4015 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
4016 # responses that do not have an existing valid TTL (max-age or s-maxage).
4017 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4018 # The value of defaultTTL cannot be set to a value greater than that of
4019 # maxTTL, but can be equal.
4020 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
4021 # will overwrite the TTL set in all responses. The maximum allowed value is
4022 # 31,622,400s (1 year), noting that infrequently accessed objects may be
4023 # evicted from the cache before the defined TTL.
4024 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
4025 # origin.
4026 # Cache directives that attempt to set a max-age or s-maxage higher than
4027 # this, or an Expires header more than maxTTL seconds in the future will
4028 # be capped at the value of maxTTL, as if it were the value of an
4029 # s-maxage Cache-Control directive.
4030 # Headers sent to the client will not be modified.
4031 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4032 # The maximum allowed value is 31,622,400s (1 year), noting that
4033 # infrequently accessed objects may be evicted from the cache before
4034 # the defined TTL.
4035 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
4036 # to apply fine-grained caching for common errors or redirects.
4037 # This can reduce the load on your origin and improve end-user
4038 # experience by reducing response latency.
4039 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
4040 # negative caching applies to responses with the specified response code
4041 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
4042 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
4043 # to all responses with the specified response code, and override any
4044 # caching headers.
4045 # By default, Cloud CDN will apply the following default TTLs to these
4046 # status codes:
4047 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
4048 # HTTP 404 (Not Found), 410 (Gone),
4049 # 451 (Unavailable For Legal Reasons): 120s
4050 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
4051 # These defaults can be overridden in negative_caching_policy.
4052 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
4053 # negative_caching must be enabled to configure negative_caching_policy.
4054 # Omitting the policy and leaving negative_caching enabled will use
4055 # Cloud CDN&#x27;s default cache TTLs.
4056 # Note that when specifying an explicit negative_caching_policy, you
4057 # should take care to specify a cache TTL for all response codes
4058 # that you wish to cache. Cloud CDN will not apply any default
4059 # negative caching when a policy exists.
4060 { # Specify CDN TTLs for response error codes.
4061 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
4062 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
4063 # specified as values, and you cannot specify a status code more than
4064 # once.
4065 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
4066 # corresponding status code.
4067 # The maximum allowed value is 1800s (30 minutes), noting that
4068 # infrequently accessed objects may be evicted from the cache before the
4069 # defined TTL.
4070 },
4071 ],
4072 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
4073 # requests into a small number of requests to the origin.
4074 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
4075 # content with the origin, or when an error is encountered when refreshing
4076 # the cache.
4077 # This setting defines the default &quot;max-stale&quot; duration for any cached
4078 # responses that do not specify a max-stale directive. Stale responses that
4079 # exceed the TTL configured here will not be served. The default limit
4080 # (max-stale) is 86400s (1 day), which will allow stale content to be
4081 # served up to this limit beyond the max-age (or s-maxage) of a cached
4082 # response.
4083 # The maximum allowed value is 604800 (1 week).
4084 # Set this to zero (0) to disable serve-while-stale.
4085 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
4086 # considered fresh. After this time period, the response will be
4087 # revalidated before being served. Defaults to 1hr (3600s). When serving
4088 # responses to signed URL requests, Cloud CDN will internally behave as
4089 # though all responses from this backend had a &quot;Cache-Control:
4090 # public, max-age=[TTL]&quot; header, regardless of any existing
4091 # Cache-Control header. The actual headers served in responses will not be
4092 # altered.
4093 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
4094 &quot;A String&quot;,
4095 ],
4096 },
4097 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
4098 # backend service.
4099 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
4100 # there is no limit.
4101 #
4102 # Not supported when the backend service is referenced by a URL map that is
4103 # bound to target gRPC proxy that has validateForProxyless field set to true.
4104 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
4105 # not specified, there is no limit.
4106 #
4107 # Not supported when the backend service is referenced by a URL map that is
4108 # bound to target gRPC proxy that has validateForProxyless field set to true.
4109 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
4110 # service. If not specified, there is no limit.
4111 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
4112 # This parameter is respected by both the HTTP/1.1 and HTTP/2
4113 # implementations. If not specified, there is no limit. Setting this
4114 # parameter to 1 will effectively disable keep alive.
4115 #
4116 # Not supported when the backend service is referenced by a URL map that is
4117 # bound to target gRPC proxy that has validateForProxyless field set to true.
4118 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
4119 # not specified, the default is 1.
4120 #
4121 # Not supported when the backend service is referenced by a URL map that is
4122 # bound to target gRPC proxy that has validateForProxyless field set to true.
4123 },
4124 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
4125 # the client&#x27;s Accept-Encoding header.
4126 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
4127 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
4128 # instance. For supported load balancers and protocols, as described inEnabling
4129 # connection draining.
4130 },
4131 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
4132 # tracking policy settings are only available for external passthrough
4133 # Network Load Balancers and internal passthrough Network Load Balancers.
4134 #
4135 # connectionTrackingPolicy cannot be specified with haPolicy.
4136 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
4137 # value is DEFAULT_FOR_PROTOCOL.
4138 #
4139 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
4140 # persist on unhealthy backends only for connection-oriented protocols
4141 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
4142 # Affinity is configured for 5-tuple. They do not persist forUDP.
4143 #
4144 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
4145 # the existing connections on the unhealthy backend are never persisted on
4146 # the unhealthy backend. They are always diverted to newly selected healthy
4147 # backends (unless all backends are unhealthy).
4148 #
4149 # If set to ALWAYS_PERSIST, existing connections always
4150 # persist on unhealthy backends regardless of protocol and session
4151 # affinity. It is generally not recommended to use this mode overriding the
4152 # default.
4153 #
4154 # For more details, see [Connection Persistence for Network Load
4155 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
4156 # and [Connection Persistence for Internal TCP/UDP Load
4157 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
4158 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
4159 # Balancers. This option is not available publicly.
4160 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
4161 # matching traffic (in seconds).
4162 #
4163 # For internal passthrough Network Load Balancers:
4164 #
4165 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
4166 # - It can be set only if Connection Tracking is less than 5-tuple
4167 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
4168 # Mode is PER_SESSION).
4169 #
4170 #
4171 #
4172 # For external passthrough Network Load Balancers the default is 60
4173 # seconds. This option is not available publicly.
4174 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
4175 # options:
4176 #
4177 # - PER_CONNECTION: This is the default mode. The Connection
4178 # Tracking is performed as per the Connection Key (default Hash Method) for
4179 # the specific protocol.
4180 # - PER_SESSION: The Connection Tracking is performed as per
4181 # the configured Session Affinity. It matches the configured Session
4182 # Affinity.
4183 #
4184 #
4185 #
4186 # For more details, see [Tracking Mode for Network Load
4187 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
4188 # and [Tracking Mode for Internal TCP/UDP Load
4189 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
4190 },
4191 &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
4192 # affinity based on HTTP headers, cookies or other properties. This load
4193 # balancing policy is applicable only for HTTP connections. The affinity to a
4194 # particular destination host will be lost when one or more hosts are
4195 # added/removed from the destination service. This field specifies parameters
4196 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
4197 #
4198 # This field is applicable to either:
4199 #
4200 # - A regional backend service with the service protocol set to HTTP,
4201 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
4202 # INTERNAL_MANAGED.
4203 # - A global backend service with the
4204 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
4205 &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
4206 # be used as the hash key for the consistent hash load balancer. If the
4207 # cookie is not present, it will be generated. This field is applicable if
4208 # the sessionAffinity is set to HTTP_COOKIE.
4209 #
4210 # Not supported when the backend service is referenced by a URL map that is
4211 # bound to target gRPC proxy that has validateForProxyless field set to true.
4212 # for load balancing policies that use a consistent hash.
4213 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
4214 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
4215 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
4216 # as a count of seconds and fractions of seconds at nanosecond
4217 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4218 # or &quot;month&quot;. Range is approximately 10,000 years.
4219 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4220 # Durations less than one second are represented with a 0
4221 # `seconds` field and a positive `nanos` field. Must be from 0
4222 # to 999,999,999 inclusive.
4223 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4224 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4225 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4226 },
4227 },
4228 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
4229 # applicable if the sessionAffinity is set toHEADER_FIELD.
4230 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
4231 # 1024. Larger ring sizes result in more granular load distributions. If the
4232 # number of hosts in the load balancing pool is larger than the ring size,
4233 # each host will be assigned a single virtual node.
4234 },
4235 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4236 # text format.
4237 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
4238 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
4239 # locality_lb_policy.
4240 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
4241 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
4242 # long and match the regular expression
4243 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
4244 # first character must be a lowercase letter, and all following
4245 # characters must be a dash, period, underscore, lowercase letter, or
4246 # digit, except the last character, which cannot be a dash, period, or
4247 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
4248 # field can only be used for a global or regional backend service with the
4249 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
4250 },
4251 ],
4252 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
4253 # custom
4254 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
4255 &quot;A String&quot;,
4256 ],
4257 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
4258 # custom
4259 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
4260 &quot;A String&quot;,
4261 ],
4262 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4263 # create the resource.
4264 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
4265 # this backend service.
4266 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
4267 # global external Application Load Balancer.
4268 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
4269 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
4270 #
4271 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
4272 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
4273 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
4274 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
4275 # externalManagedMigrationTestingPercentage.
4276 #
4277 # Rolling back a migration requires the states to be set in reverse order. So
4278 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
4279 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
4280 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
4281 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
4282 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
4283 # external Application Load Balancer.
4284 #
4285 # The value of this field must be in the range [0, 100].
4286 #
4287 # Session affinity options will slightly affect this routing behavior, for
4288 # more details, see:Session
4289 # Affinity.
4290 #
4291 # This value can only be set if the loadBalancingScheme in the BackendService
4292 # is set to EXTERNAL (when using the classic Application Load Balancer) and
4293 # the migration state is TEST_BY_PERCENTAGE.
4294 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
4295 # as a backup (failover) backend.
4296 # For load balancers that have configurable failover:
4297 # [Internal passthrough Network Load
4298 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4299 # and [external passthrough Network Load
4300 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4301 #
4302 # failoverPolicy cannot be specified with haPolicy.
4303 # failover:
4304 # [Internal passthrough Network Load
4305 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4306 # and [external passthrough
4307 # Network Load
4308 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4309 # On failover or failback, this field indicates whether connection draining
4310 # will be honored. Google Cloud has a fixed connection draining timeout of
4311 # 10 minutes. A setting of true terminates existing TCP
4312 # connections to the active pool during failover and failback, immediately
4313 # draining traffic. A setting of false allows existing TCP
4314 # connections to persist, even on VMs no longer in the active pool, for up
4315 # to the duration of the connection draining timeout (10 minutes).
4316 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
4317 #
4318 # The default is false.
4319 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
4320 # load balancer are dropped when all primary and all backup backend VMs are
4321 # unhealthy.If set to false, connections are distributed
4322 # among all primary VMs when all primary and all backup backend VMs are
4323 # unhealthy.
4324 # For load balancers that have configurable
4325 # failover:
4326 # [Internal passthrough
4327 # Network Load
4328 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4329 # and [external passthrough
4330 # Network Load
4331 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4332 # The default is false.
4333 &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
4334 # failover when the number of healthy primary VMs equals zero.
4335 # For all other values, the load balancer performs a failover when the
4336 # total number of healthy primary VMs is less than this ratio.
4337 # For load balancers that have configurable
4338 # failover:
4339 # [Internal TCP/UDP Load
4340 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4341 # and [external TCP/UDP Load
4342 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4343 },
4344 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
4345 # This field is used in optimistic locking. This field will be ignored when
4346 # inserting a BackendService. An up-to-date fingerprint must be provided in
4347 # order to update the BackendService, otherwise the request will
4348 # fail with error 412 conditionNotMet.
4349 #
4350 # To see the latest fingerprint, make a get() request to
4351 # retrieve a BackendService.
4352 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
4353 # Protocol Forwarding.
4354 #
4355 # The backends of this regional backend service must only specify zonal
4356 # network endpoint groups (NEGs) of type GCE_VM_IP.
4357 #
4358 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
4359 # regional backend service must set the network field. All zonal NEGs must
4360 # belong to the same network. However, individual NEGs can
4361 # belong to different subnetworks of that network.
4362 #
4363 # When haPolicy is specified, the set of attached network endpoints across
4364 # all backends comprise an High Availability domain from which one endpoint
4365 # is selected as the active endpoint (the leader) that receives all
4366 # traffic.
4367 #
4368 # haPolicy can be added only at backend service creation time. Once set up,
4369 # it cannot be deleted.
4370 #
4371 # Note that haPolicy is not for load balancing, and therefore cannot be
4372 # specified with sessionAffinity, connectionTrackingPolicy, and
4373 # failoverPolicy.
4374 #
4375 # haPolicy requires customers to be responsible for tracking backend
4376 # endpoint health and electing a leader among the healthy endpoints.
4377 # Therefore, haPolicy cannot be specified with healthChecks.
4378 #
4379 # haPolicy can only be specified for External Passthrough Network Load
4380 # Balancers and Internal Passthrough Network Load Balancers.
4381 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
4382 # achieve it.
4383 #
4384 # Supported values are:
4385 #
4386 # - DISABLED: Fast IP Move is disabled. You can only use the
4387 # haPolicy.leader API to update the leader.
4388 # - &gt;GARP_RA: Provides a method to very quickly define a new network
4389 # endpoint as the leader. This method is faster than updating the leader
4390 # using the haPolicy.leader API. Fast IP move works as follows: The VM
4391 # hosting the network endpoint that should become the new leader sends
4392 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
4393 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
4394 # temporarily associates the forwarding rule IP address with that VM, and
4395 # both new and in-flight packets are quickly delivered to that VM.
4396 #
4397 #
4398 #
4399 # Note the important properties of the Fast IP Move functionality:
4400 #
4401 # - The GARP/RA-initiated re-routing stays active for approximately 20
4402 # minutes. After triggering fast failover, you must also
4403 # appropriately set the haPolicy.leader.
4404 # - The new leader instance should continue to send GARP/RA packets
4405 # periodically every 10 seconds until at least 10 minutes after updating
4406 # the haPolicy.leader (but stop immediately if it is no longer the leader).
4407 # - After triggering a fast failover, we recommend that you wait at least
4408 # 3 seconds before sending another GARP/RA packet from a different VM
4409 # instance to avoid race conditions.
4410 # - Don&#x27;t send GARP/RA packets from different VM
4411 # instances at the same time. If multiple instances continue to send
4412 # GARP/RA packets, traffic might be routed to different destinations in an
4413 # alternating order. This condition ceases when a single instance
4414 # issues a GARP/RA packet.
4415 # - The GARP/RA request always takes priority over the leader API.
4416 # Using the haPolicy.leader API to change the leader to a different
4417 # instance will have no effect until the GARP/RA request becomes
4418 # inactive.
4419 # - The GARP/RA packets should follow the GARP/RA
4420 # Packet Specifications..
4421 # - When multiple forwarding rules refer to a regional backend service,
4422 # you need only send a GARP or RA packet for a single forwarding rule
4423 # virtual IP. The virtual IPs for all forwarding rules targeting the same
4424 # backend service will also be moved to the sender of the GARP or RA
4425 # packet.
4426 #
4427 #
4428 #
4429 # The following are the Fast IP Move limitations (that is, when fastIPMove
4430 # is not DISABLED):
4431 #
4432 # - Multiple forwarding rules cannot use the same IP address if one of
4433 # them refers to a regional backend service with fastIPMove.
4434 # - The regional backend service must set the network field, and all
4435 # NEGs must belong to that network. However, individual
4436 # NEGs can belong to different subnetworks of that network.
4437 # - The maximum number of network endpoints across all backends of a
4438 # backend service with fastIPMove is 32.
4439 # - The maximum number of backend services with fastIPMove that can have
4440 # the same network endpoint attached to one of its backends is 64.
4441 # - The maximum number of backend services with fastIPMove in a VPC in a
4442 # region is 64.
4443 # - The network endpoints that are attached to a backend of a backend
4444 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
4445 # - Traffic directed to the leader by a static route next hop will not be
4446 # redirected to a new leader by fast failover. Such traffic will only be
4447 # redirected once an haPolicy.leader update has taken effect. Only traffic
4448 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
4449 # fast failover.
4450 #
4451 #
4452 # haPolicy.fastIPMove can be set only at backend service creation time.
4453 # Once set, it cannot be updated.
4454 #
4455 # By default, fastIpMove is set to DISABLED.
4456 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
4457 # this service as the active endpoint (the leader) that receives all
4458 # traffic.
4459 #
4460 # When the leader changes, there is no connection draining to persist
4461 # existing connections on the old leader.
4462 #
4463 # You are responsible for selecting a suitable endpoint as the
4464 # leader. For example, preferring a healthy endpoint over unhealthy ones.
4465 # Note that this service does not track backend endpoint health, and
4466 # selects the configured leader unconditionally.
4467 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
4468 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
4469 # that the leader is attached to.
4470 #
4471 # The leader&#x27;s backendGroup must already be specified as a backend of
4472 # this backend service. Removing a backend that is designated as the
4473 # leader&#x27;s backendGroup is not permitted.
4474 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
4475 # designated as the leader.
4476 #
4477 # This network endpoint cannot be detached from the NEG specified in
4478 # the haPolicy.leader.backendGroup until the leader is updated with
4479 # another network endpoint, or the leader is removed from the haPolicy.
4480 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
4481 # instance must already be attached to the NEG specified in the
4482 # haPolicy.leader.backendGroup.
4483 #
4484 # The name must be 1-63 characters long, and comply with RFC1035.
4485 # Authorization requires the following IAM permission on the
4486 # specified resource instance: compute.instances.use
4487 },
4488 },
4489 },
4490 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
4491 # httpsHealthChecks (legacy) resource for health checking this backend
4492 # service. Not all backend services support legacy health checks. See
4493 # Load balancer guide. Currently, at most one health check can be
4494 # specified for each backend service. Backend services with
4495 # instance group or zonal NEG backends must have a health check unless
4496 # haPolicy is specified. Backend services with internet or serverless NEG
4497 # backends must not have a health check.
4498 #
4499 # healthChecks[] cannot be specified with haPolicy.
4500 &quot;A String&quot;,
4501 ],
4502 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
4503 # Not available for internal passthrough Network Load Balancers and external
4504 # passthrough Network Load Balancers.
4505 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
4506 # incoming requests.
4507 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
4508 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
4509 # For security reasons, this value cannot be retrieved via the API.
4510 # Instead, the SHA-256 hash of the value is returned in the
4511 # oauth2ClientSecretSha256 field.
4512 #
4513 # @InputOnly
4514 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
4515 },
4516 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4517 # defined by the server.
4518 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
4519 # from the client to the backend for proxyless gRPC).
4520 # The possible values are:
4521 #
4522 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
4523 # backend service (Instance Group, Managed Instance Group, Network Endpoint
4524 # Group), regardless of traffic from the client to the proxy. Only IPv4
4525 # health checks are used to check the health of the backends. This is the
4526 # default setting.
4527 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
4528 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
4529 # address).
4530 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
4531 # backend service (Instance Group, Managed Instance Group, Network Endpoint
4532 # Group), regardless of traffic from the client to the proxy. Only IPv6
4533 # health checks are used to check the health of the backends.
4534 #
4535 #
4536 #
4537 # This field is applicable to either:
4538 #
4539 # - Advanced global external Application Load Balancer (load balancing
4540 # scheme EXTERNAL_MANAGED),
4541 # - Regional external Application Load
4542 # Balancer,
4543 # - Internal proxy Network Load Balancer (load balancing
4544 # scheme INTERNAL_MANAGED),
4545 # - Regional internal Application Load
4546 # Balancer (load balancing scheme INTERNAL_MANAGED),
4547 # - Traffic
4548 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
4549 # INTERNAL_SELF_MANAGED).
4550 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
4551 # for backend services.
4552 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
4553 # created for one type of load balancer cannot be used with another.
4554 # For more information, refer toChoosing
4555 # a load balancer.
4556 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
4557 # preference. When you use localityLbPolicies, you must set at least one
4558 # value for either the localityLbPolicies[].policy or the
4559 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
4560 # value set in the localityLbPolicy field.
4561 #
4562 # For an example of how to use this field, seeDefine
4563 # a list of preferred policies.
4564 #
4565 # Caution: This field and its children are intended for use in a service mesh
4566 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
4567 # that have this configuration.
4568 { # Container for either a built-in LB policy supported by gRPC or Envoy or
4569 # a custom one implemented by the end user.
4570 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
4571 # deployed with the client.
4572 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
4573 # by a locally installed custom policy implementation.
4574 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
4575 #
4576 # The value should match the name of a custom implementation registered
4577 # on the gRPC clients. It should follow protocol buffer message naming
4578 # conventions and include the full path (for example,
4579 # myorg.CustomLbPolicy). The maximum length is 256 characters.
4580 #
4581 # Do not specify the same custom policy more than once for a
4582 # backend. If you do, the configuration is rejected.
4583 #
4584 # For an example of how to use this field, seeUse
4585 # a custom policy.
4586 },
4587 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
4588 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
4589 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
4590 # about these values, see the description of localityLbPolicy.
4591 #
4592 # Do not specify the same policy more than once for a
4593 # backend. If you do, the configuration is rejected.
4594 },
4595 },
4596 ],
4597 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
4598 # possible values are:
4599 #
4600 # - ROUND_ROBIN: This is a simple policy in which each healthy
4601 # backend is selected in round robin order. This is the default.
4602 # - LEAST_REQUEST: An O(1) algorithm which
4603 # selects two random healthy hosts and picks the host which has fewer active
4604 # requests.
4605 # - RING_HASH: The ring/modulo hash load balancer implements
4606 # consistent hashing to backends. The algorithm has the property that the
4607 # addition/removal of a host from a set of N hosts only affects 1/N of the
4608 # requests.
4609 # - RANDOM: The load balancer selects a random healthy
4610 # host.
4611 # - ORIGINAL_DESTINATION: Backend host is selected
4612 # based on the client connection metadata, i.e., connections are opened to
4613 # the same address as the destination address of the incoming connection
4614 # before the connection was redirected to the load balancer.
4615 # - MAGLEV: used as a drop in replacement for the ring hash
4616 # load balancer. Maglev is not as stable as ring hash but has faster table
4617 # lookup build times and host selection times. For more information about
4618 # Maglev, see Maglev:
4619 # A Fast and Reliable Software Network Load Balancer.
4620 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
4621 # Load Balancing using weights computed from Backend reported Custom Metrics.
4622 # If set, the Backend Service responses are expected to contain non-standard
4623 # HTTP response header field Endpoint-Load-Metrics. The reported
4624 # metrics to use for computing the weights are specified via thecustomMetrics field.
4625 #
4626 # This field is applicable to either:
4627 # - A regional backend service with the service protocol set to HTTP,
4628 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
4629 # INTERNAL_MANAGED.
4630 # - A global backend service with the
4631 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
4632 # EXTERNAL_MANAGED.
4633 #
4634 #
4635 # If sessionAffinity is not configured—that is, if session
4636 # affinity remains at the default value of NONE—then the
4637 # default value for localityLbPolicy
4638 # is ROUND_ROBIN. If session affinity is set to a value other
4639 # than NONE,
4640 # then the default value for localityLbPolicy isMAGLEV.
4641 #
4642 # Only ROUND_ROBIN and RING_HASH are supported
4643 # when the backend service is referenced by a URL map that is bound to
4644 # target gRPC proxy that has validateForProxyless field set to true.
4645 #
4646 # localityLbPolicy cannot be specified with haPolicy.
4647 &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
4648 # by this backend service. If logging is enabled, logs will be exported to
4649 # Stackdriver.
4650 # backend service.
4651 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
4652 # traffic served by this backend service. The default value is false.
4653 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
4654 { # Determines which HTTP headers will be logged to Stackdriver.
4655 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
4656 },
4657 ],
4658 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
4659 { # Determines which HTTP headers will be logged to Stackdriver.
4660 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
4661 },
4662 ],
4663 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
4664 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
4665 # of optional fields you want to include in the logs. For example:
4666 # serverInstance, serverGkeDetails.cluster,
4667 # serverGkeDetails.pod.podNamespace
4668 &quot;A String&quot;,
4669 ],
4670 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
4671 # service. Configures whether all, none or a subset of optional fields
4672 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
4673 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
4674 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
4675 # service. The value of the field must be in [0, 1]. This configures the
4676 # sampling rate of requests to the load balancer where 1.0 means all logged
4677 # requests are reported and 0.0 means no logged requests are reported. The
4678 # default value is 1.0.
4679 },
4680 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
4681 # service. Duration is computed from the beginning of the stream until the
4682 # response has been completely processed, including all retries. A stream
4683 # that does not complete in this duration is closed.
4684 #
4685 # If not specified, there will be no timeout limit, i.e. the maximum
4686 # duration is infinite.
4687 #
4688 # This value can be overridden in the PathMatcher configuration of the
4689 # UrlMap that references this backend service.
4690 #
4691 # This field is only allowed when the loadBalancingScheme of
4692 # the backend service is INTERNAL_SELF_MANAGED.
4693 # as a count of seconds and fractions of seconds at nanosecond
4694 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4695 # or &quot;month&quot;. Range is approximately 10,000 years.
4696 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4697 # Durations less than one second are represented with a 0
4698 # `seconds` field and a positive `nanos` field. Must be from 0
4699 # to 999,999,999 inclusive.
4700 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4701 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4702 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4703 },
4704 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
4705 # controller and read by the backend RCTH
4706 &quot;a_key&quot;: &quot;A String&quot;,
4707 },
4708 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4709 # The name must be 1-63 characters long, and comply withRFC1035.
4710 # Specifically, the name must be 1-63 characters long and match the regular
4711 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4712 # character must be a lowercase letter, and all following characters must
4713 # be a dash, lowercase letter, or digit, except the last character, which
4714 # cannot be a dash.
4715 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
4716 #
4717 # This field must be set for Internal Passthrough Network Load Balancers when
4718 # the haPolicy is enabled, and for External Passthrough Network Load
4719 # Balancers when the haPolicy fastIpMove is enabled.
4720 #
4721 # 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.
4722 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
4723 # Load Balancers.
4724 #
4725 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
4726 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
4727 # endpoints in the local zone.
4728 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
4729 # possible values are:
4730 #
4731 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
4732 # is disabled. The load balancer distributes new connections to all
4733 # healthy backend endpoints across all zones.
4734 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
4735 # enabled. The load balancer distributes new connections to all healthy
4736 # backend endpoints in the local zone only. If there are no healthy
4737 # backend endpoints in the local zone, the load balancer distributes
4738 # new connections to all backend endpoints in the local zone.
4739 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
4740 # enabled. The load balancer distributes new connections to all healthy
4741 # backend endpoints in the local zone only. If there aren&#x27;t enough
4742 # healthy backend endpoints in the local zone, the load balancer
4743 # distributes new connections to all healthy backend endpoints across all
4744 # zones.
4745 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
4746 # of healthy backend endpoints in a zone to the count of backend
4747 # endpoints in that same zone is equal to or above this threshold, the
4748 # load balancer distributes new connections to all healthy endpoints in
4749 # the local zone only. When the ratio of the count of healthy backend
4750 # endpoints in a zone to the count of backend endpoints in that same
4751 # zone is below this threshold, the load balancer distributes all new
4752 # connections to all healthy endpoints across all zones.
4753 },
4754 },
4755 &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.
4756 # the backend service.
4757 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
4758 # service.
4759 },
4760 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
4761 # load balancing pool of each individual proxy instance that processes the
4762 # traffic for the given backend service. If not set, this feature is
4763 # considered disabled.
4764 #
4765 # Results of the outlier detection algorithm (ejection of endpoints from the
4766 # load balancing pool and returning them back to the pool) are executed
4767 # independently by each proxy instance of the load balancer. In most cases,
4768 # more than one proxy instance handles the traffic received by a backend
4769 # service. Thus, it is possible that an unhealthy endpoint is detected and
4770 # ejected by only some of the proxies, and while this happens, other proxies
4771 # may continue to send requests to the same unhealthy endpoint until they
4772 # detect and eject the unhealthy endpoint.
4773 #
4774 # Applicable backend endpoints can be:
4775 #
4776 # - VM instances in an Instance Group
4777 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
4778 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
4779 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
4780 # Functions Services
4781 # - Private Service Connect NEGs, that resolve to
4782 # Google-managed regional API endpoints or managed services published using
4783 # Private Service Connect
4784 #
4785 #
4786 #
4787 # Applicable backend service types can be:
4788 #
4789 # - A global backend service with the loadBalancingScheme set to
4790 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
4791 # - A regional backend
4792 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
4793 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
4794 # supported for Serverless NEGs.
4795 #
4796 #
4797 #
4798 # Not supported when the backend service is referenced by a URL map that is
4799 # bound to target gRPC proxy that has validateForProxyless field set to true.
4800 # pool for the backend service.
4801 &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
4802 # or 30s.
4803 #
4804 # After a backend endpoint is returned back to the load balancing pool, it
4805 # can be ejected again in another ejection analysis. Thus, the total ejection
4806 # time is equal to the base ejection time multiplied by the number of times
4807 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
4808 # as a count of seconds and fractions of seconds at nanosecond
4809 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4810 # or &quot;month&quot;. Range is approximately 10,000 years.
4811 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4812 # Durations less than one second are represented with a 0
4813 # `seconds` field and a positive `nanos` field. Must be from 0
4814 # to 999,999,999 inclusive.
4815 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4816 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4817 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4818 },
4819 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
4820 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
4821 # return code qualifies as an error. Defaults to 5.
4822 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
4823 # connection errors that are mapped to one of those status codes) before a
4824 # consecutive gateway failure ejection occurs. Defaults to 3.
4825 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
4826 # outlier status is detected through consecutive 5xx. This setting can be
4827 # used to disable ejection or to ramp it up slowly. Defaults to 0.
4828 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
4829 # outlier status is detected through consecutive gateway failures. This
4830 # setting can be used to disable ejection or to ramp it up slowly. Defaults
4831 # to 100.
4832 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
4833 # outlier status is detected through success rate statistics. This setting
4834 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
4835 #
4836 # Not supported when the backend service uses Serverless NEG.
4837 &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
4838 # ejections and backend endpoints being returned to service. The interval is
4839 # equal to the number of seconds as defined in
4840 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
4841 # in outlierDetection.interval.nanos. Defaults to 1 second.
4842 # as a count of seconds and fractions of seconds at nanosecond
4843 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4844 # or &quot;month&quot;. Range is approximately 10,000 years.
4845 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4846 # Durations less than one second are represented with a 0
4847 # `seconds` field and a positive `nanos` field. Must be from 0
4848 # to 999,999,999 inclusive.
4849 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4850 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4851 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4852 },
4853 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
4854 # backend service that can be ejected if the ejection conditions are met.
4855 # Defaults to 50%.
4856 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
4857 # enough request volume to detect success rate outliers. If the number of
4858 # backend endpoints is fewer than this setting, outlier detection via success
4859 # rate statistics is not performed for any backend endpoint in the load
4860 # balancing pool. Defaults to 5.
4861 #
4862 # Not supported when the backend service uses Serverless NEG.
4863 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
4864 # (as defined by the interval duration above) to include this backend
4865 # endpoint in success rate based outlier detection. If the volume is lower
4866 # than this setting, outlier detection via success rate statistics is not
4867 # performed for that backend endpoint. Defaults to 100.
4868 #
4869 # Not supported when the backend service uses Serverless NEG.
4870 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
4871 # outlier ejection. The ejection threshold is the difference between the mean
4872 # success rate, and the product of this factor and the standard deviation of
4873 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
4874 # is divided by a thousand to get a double. That is, if the desired factor
4875 # is 1.9, the runtime value should be 1900. Defaults to 1900.
4876 #
4877 # Not supported when the backend service uses Serverless NEG.
4878 },
4879 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
4880 # as part of resource payload.
4881 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
4882 # Tag keys and values have the same definition as resource
4883 # manager tags. The field is allowed for INSERT
4884 # only. The keys/values to set on the resource should be specified in
4885 # either ID { : } or Namespaced format
4886 # { : }.
4887 # For example the following are valid inputs:
4888 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
4889 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
4890 # Note:
4891 # * Invalid combinations of ID &amp; namespaced format is not supported. For
4892 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
4893 &quot;a_key&quot;: &quot;A String&quot;,
4894 },
4895 },
4896 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
4897 # the backend. The default value is 80.
4898 # For internal passthrough Network Load Balancers and external passthrough
4899 # Network Load Balancers, omit port.
4900 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
4901 # communication to the backend VMs in that group. The
4902 # named port must be [defined on each backend instance
4903 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
4904 # This parameter has no meaning if the backends are NEGs. For internal
4905 # passthrough Network Load Balancers and external passthrough Network Load
4906 # Balancers, omit port_name.
4907 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
4908 # with backends.
4909 #
4910 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
4911 # depending on the chosen load balancer or Traffic Director configuration.
4912 # Refer to the documentation for the load balancers or for Traffic Director
4913 # for more information.
4914 #
4915 # Must be set to GRPC when the backend service is referenced by a URL map
4916 # that is bound to target gRPC proxy.
4917 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
4918 # resides. This field is not applicable to global backend services.
4919 # You must specify this field as part of the HTTP request URL. It is
4920 # not settable as a field in the request body.
4921 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
4922 # backend service.
4923 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
4924 # service. This field is applicable to a global backend service with the
4925 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
4926 &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
4927 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
4928 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
4929 # private storage buckets that support Signature Version 4 for authentication.
4930 # The service name for generating the authentication header will always default
4931 # to &#x27;s3&#x27;.
4932 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
4933 # creating a backend that uses AWS v4 signature authentication, but will not
4934 # be returned as part of the configuration when queried with a REST API GET
4935 # request.
4936 #
4937 # @InputOnly
4938 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
4939 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
4940 # keep track of different iterations of your access key.
4941 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
4942 # the name of the region your cloud uses to host your origin. For example,
4943 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
4944 },
4945 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
4946 # that describes how clients should authenticate with this service&#x27;s
4947 # backends.
4948 #
4949 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
4950 # to INTERNAL_SELF_MANAGED.
4951 #
4952 # If left blank, communications are not encrypted.
4953 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
4954 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
4955 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
4956 # specified values, the communication continues. Otherwise, it fails. This
4957 # additional check enables the client to verify that the server is authorized
4958 # to run the requested service.
4959 #
4960 # Note that the contents of the server
4961 # certificate&#x27;s subjectAltName field are configured by the
4962 # Public Key Infrastructure which provisions server identities.
4963 #
4964 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
4965 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
4966 # mode).
4967 &quot;A String&quot;,
4968 ],
4969 },
4970 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4971 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
4972 #
4973 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
4974 # If set, lists of backends and health checks must be both empty.
4975 &quot;A String&quot;,
4976 ],
4977 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
4978 #
4979 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
4980 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
4981 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
4982 #
4983 # Only NONE and HEADER_FIELD are supported
4984 # when the backend service is referenced by a URL map that is bound to
4985 # target gRPC proxy that has validateForProxyless field set to true.
4986 #
4987 # For more details, see:
4988 # [Session
4989 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
4990 #
4991 # sessionAffinity cannot be specified with haPolicy.
4992 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
4993 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
4994 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
4995 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
4996 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
4997 # as a count of seconds and fractions of seconds at nanosecond
4998 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4999 # or &quot;month&quot;. Range is approximately 10,000 years.
5000 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5001 # Durations less than one second are represented with a 0
5002 # `seconds` field and a positive `nanos` field. Must be from 0
5003 # to 999,999,999 inclusive.
5004 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5005 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5006 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5007 },
5008 },
5009 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
5010 # Currently this is applicable only for Internal TCP/UDP load balancing,
5011 # Internal HTTP(S) load balancing and Traffic Director.
5012 &quot;policy&quot;: &quot;A String&quot;,
5013 },
5014 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
5015 # type of load balancer. For more information see,
5016 # Backend service settings.
5017 # The default is 30 seconds.
5018 # The full range of timeout values allowed goes from 1
5019 # through 2,147,483,647 seconds.
5020 #
5021 # This value can be overridden in the PathMatcher configuration of the
5022 # UrlMap that references this backend service.
5023 #
5024 # Not supported when the backend service is referenced by a URL map that is
5025 # bound to target gRPC proxy that has validateForProxyless field set to true.
5026 # Instead, use maxStreamDuration.
5027 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
5028 # when the backend protocol is SSL, HTTPS or HTTP2.
5029 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
5030 # networksecurity.googleapis.com namespace. Can be used in authenticating
5031 # TLS connections to the backend, as specified by the authenticationMode
5032 # field. Can only be specified if authenticationMode is not NONE.
5033 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
5034 # balancer sends this string as the SNI hostname in the TLS connection to
5035 # the backend, and requires that this string match a Subject Alternative
5036 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
5037 # NEG backend, if the SNI is specified here, the load balancer uses it
5038 # regardless of whether the Regional Internet NEG is specified with FQDN or
5039 # IP address and port. When both sni and subjectAltNames[] are specified,
5040 # the load balancer matches the backend certificate&#x27;s SAN only to
5041 # subjectAltNames[].
5042 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
5043 # verifies during a TLS handshake with the backend. When the server
5044 # presents its X.509 certificate to the Load Balancer, the Load Balancer
5045 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
5046 # match one of the subjectAltNames in the list. This field is limited to 5
5047 # entries. When both sni and subjectAltNames[] are specified, the load
5048 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
5049 { # A Subject Alternative Name that the load balancer matches against the SAN
5050 # field in the TLS certificate provided by the backend, specified as either
5051 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
5052 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
5053 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
5054 },
5055 ],
5056 },
5057 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
5058 {
5059 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
5060 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
5061 # and ForwardingRule.
5062 },
5063 ],
5064 },
5065 ],
5066 &quot;kind&quot;: &quot;compute#backendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.
5067 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5068 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5069 # the query parameter pageToken in the next list request.
5070 # Subsequent list requests will have their own nextPageToken to
5071 # continue paging through the results.
5072 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5073 &quot;warning&quot;: { # [Output Only] Informational warning message.
5074 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5075 # Engine returns NO_RESULTS_ON_PAGE if there
5076 # are no results in the response.
5077 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5078 # value format. For example:
5079 #
5080 # &quot;data&quot;: [
5081 # {
5082 # &quot;key&quot;: &quot;scope&quot;,
5083 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5084 # }
5085 {
5086 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5087 # returned. For example, for warnings where there are no results in a list
5088 # request for a particular zone, this key might be scope and
5089 # the key value might be the zone name. Other examples might be a key
5090 # indicating a deprecated resource and a suggested replacement, or a
5091 # warning about invalid network settings (for example, if an instance
5092 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5093 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5094 },
5095 ],
5096 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5097 },
5098 }</pre>
5099 </div>
5100
5101 <div class="method">
5102 <code class="details" id="listUsable">listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5103 <pre>Retrieves a list of all usable backend services in the specified project in
5104 the given region.
5105
5106 Args:
5107 project: string, Project ID for this request. (required)
5108 region: string, Name of the region scoping this request.
5109 It must be a string that meets the requirements in RFC1035. (required)
5110 filter: string, A filter expression that filters resources listed in the response. Most
5111 Compute resources support two types of filter expressions:
5112 expressions that support regular expressions and expressions that follow
5113 API improvement proposal AIP-160.
5114 These two types of filter expressions cannot be mixed in one request.
5115
5116 If you want to use AIP-160, your expression must specify the field name, an
5117 operator, and the value that you want to use for filtering. The value
5118 must be a string, a number, or a boolean. The operator
5119 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5120
5121 For example, if you are filtering Compute Engine instances, you can
5122 exclude instances named `example-instance` by specifying
5123 `name != example-instance`.
5124
5125 The `:*` comparison can be used to test whether a key has been defined.
5126 For example, to find all objects with `owner` label use:
5127 ```
5128 labels.owner:*
5129 ```
5130
5131 You can also filter nested fields. For example, you could specify
5132 `scheduling.automaticRestart = false` to include instances only
5133 if they are not scheduled for automatic restarts. You can use filtering
5134 on nested fields to filter based onresource labels.
5135
5136 To filter on multiple expressions, provide each separate expression within
5137 parentheses. For example:
5138 ```
5139 (scheduling.automaticRestart = true)
5140 (cpuPlatform = &quot;Intel Skylake&quot;)
5141 ```
5142 By default, each expression is an `AND` expression. However, you
5143 can include `AND` and `OR` expressions explicitly.
5144 For example:
5145 ```
5146 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5147 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5148 (scheduling.automaticRestart = true)
5149 ```
5150
5151 If you want to use a regular expression, use the `eq` (equal) or `ne`
5152 (not equal) operator against a single un-parenthesized expression with or
5153 without quotes or against multiple parenthesized expressions. Examples:
5154
5155 `fieldname eq unquoted literal`
5156 `fieldname eq &#x27;single quoted literal&#x27;`
5157 `fieldname eq &quot;double quoted literal&quot;`
5158 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5159
5160 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5161 The literal value must match the entire field.
5162
5163 For example, to filter for instances that do not end with name &quot;instance&quot;,
5164 you would use `name ne .*instance`.
5165
5166 You cannot combine constraints on multiple fields using regular
5167 expressions.
5168 maxResults: integer, The maximum number of results per page that should be returned.
5169 If the number of available results is larger than `maxResults`,
5170 Compute Engine returns a `nextPageToken` that can be used to get
5171 the next page of results in subsequent list requests. Acceptable values are
5172 `0` to `500`, inclusive. (Default: `500`)
5173 orderBy: string, Sorts list results by a certain order. By default, results
5174 are returned in alphanumerical order based on the resource name.
5175
5176 You can also sort results in descending order based on the creation
5177 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5178 results based on the `creationTimestamp` field in
5179 reverse chronological order (newest result first). Use this to sort
5180 resources like operations so that the newest operation is returned first.
5181
5182 Currently, only sorting by `name` or
5183 `creationTimestamp desc` is supported.
5184 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5185 `nextPageToken` returned by a previous list request to get
5186 the next page of results.
5187 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5188 of failure. The default value is false.
5189
5190 For example, when partial success behavior is enabled, aggregatedList for a
5191 single zone scope either returns all resources in the zone or no resources,
5192 with an error code.
5193 x__xgafv: string, V1 error format.
5194 Allowed values
5195 1 - v1 error format
5196 2 - v2 error format
5197
5198 Returns:
5199 An object of the form:
5200
5201 { # Contains a list of usable BackendService resources.
5202 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
5203 &quot;items&quot;: [ # A list of BackendService resources.
5204 { # Represents a Backend Service resource.
5205 #
5206 # A backend service defines how Google Cloud load balancers distribute traffic.
5207 # The backend service configuration contains a set of values, such as the
5208 # protocol used to connect to backends, various distribution and session
5209 # settings, health checks, and timeouts. These settings provide fine-grained
5210 # control over how your load balancer behaves. Most of the settings have
5211 # default values that allow for easy configuration if you need to get started
5212 # quickly.
5213 #
5214 # Backend services in Google Compute Engine can be either regionally or
5215 # globally scoped.
5216 #
5217 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
5218 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
5219 #
5220 # For more information, seeBackend
5221 # Services.
5222 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
5223 # Load Balancers and Traffic Director and requires
5224 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
5225 #
5226 # If set to 0, the cookie is non-persistent and lasts only until
5227 # the end of the browser session (or equivalent). The maximum allowed value
5228 # is two weeks (1,209,600).
5229 #
5230 # Not supported when the backend service is referenced by a URL map that is
5231 # bound to target gRPC proxy that has validateForProxyless field set to true.
5232 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
5233 { # Message containing information of one individual backend.
5234 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
5235 # handle additional traffic or is fully loaded. For usage guidelines, see
5236 # Connection balancing mode.
5237 #
5238 # Backends must use compatible balancing modes. For more information, see
5239 # Supported balancing modes and target capacity settings and
5240 # Restrictions and guidance for instance groups.
5241 #
5242 # Note: Currently, if you use the API to configure incompatible balancing
5243 # modes, the configuration might be accepted even though it has no impact
5244 # and is ignored. Specifically, Backend.maxUtilization is ignored when
5245 # Backend.balancingMode is RATE. In the future, this incompatible combination
5246 # will be rejected.
5247 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
5248 # mode.
5249 # The default value is 1, which means the group serves up to
5250 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
5251 # completely drained, offering 0% of its available capacity. The valid ranges
5252 # are 0.0 and [0.1,1.0].
5253 # You cannot configure a setting larger than 0 and smaller than0.1.
5254 # You cannot configure a setting of 0 when there is only one
5255 # backend attached to the backend service.
5256 #
5257 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
5258 # internet NEGs, regional serverless NEGs, and PSC NEGs.
5259 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
5260 # BalancingMode.
5261 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
5262 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
5263 # Monitoring, but is not used for load balancing.
5264 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
5265 # balancing mode. The valid range is [0.0, 1.0].
5266 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5267 # long and match the regular expression
5268 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5269 # first character must be a lowercase letter, and all following
5270 # characters must be a dash, period, underscore, lowercase letter, or
5271 # digit, except the last character, which cannot be a dash, period, or
5272 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5273 # field can only be used for a global or regional backend service with the
5274 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5275 },
5276 ],
5277 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5278 # create the resource.
5279 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
5280 # failover backend can be configured for a given BackendService.
5281 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
5282 # group or network endpoint
5283 # group (NEG) resource. To determine what types of backends a load
5284 # balancer supports, see the [Backend services
5285 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
5286 #
5287 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
5288 # or NEG. Partial URLs are not supported.
5289 #
5290 # If haPolicy is specified, backends must refer to NEG resources of type
5291 # GCE_VM_IP.
5292 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5293 # guidelines, seeConnection
5294 # balancing mode and Utilization
5295 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
5296 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5297 # guidelines, seeConnection
5298 # balancing mode and Utilization
5299 # balancing mode.
5300 #
5301 # Not available if the backend&#x27;s balancingMode isRATE.
5302 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
5303 # For usage guidelines, seeConnection
5304 # balancing mode and Utilization
5305 # balancing mode.
5306 #
5307 # Not available if the backend&#x27;s balancingMode isRATE.
5308 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
5309 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
5310 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
5311 # Not available if backend&#x27;s balancingMode is RATE
5312 # or CONNECTION.
5313 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
5314 # Not available if backend&#x27;s balancingMode is RATE
5315 # or CONNECTION.
5316 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
5317 # usage guidelines, seeRate
5318 # balancing mode and Utilization
5319 # balancing mode.
5320 #
5321 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5322 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
5323 # guidelines, seeRate
5324 # balancing mode and Utilization
5325 # balancing mode.
5326 #
5327 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5328 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
5329 # guidelines, seeRate
5330 # balancing mode and Utilization
5331 # balancing mode.
5332 #
5333 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5334 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
5335 #
5336 # For usage guidelines, seeUtilization
5337 # balancing mode.
5338 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
5339 # the backend.
5340 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
5341 },
5342 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
5343 # sending traffic to backends with default preference. The possible values
5344 # are:
5345 #
5346 # - PREFERRED: Backends with this preference level will be
5347 # filled up to their capacity limits first, based on RTT.
5348 # - DEFAULT: If preferred backends don&#x27;t have enough
5349 # capacity, backends in this layer would be used and traffic would be
5350 # assigned based on the load balancing algorithm you use. This is the
5351 # default
5352 &quot;trafficDuration&quot;: &quot;A String&quot;,
5353 },
5354 ],
5355 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
5356 # specified load balancer types.
5357 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
5358 # Pragma or Authorization headers. Up to 5 headers can be specified.
5359 # The cache is bypassed for all cdnPolicy.cacheMode settings.
5360 { # Bypass the cache when the specified request headers are present,
5361 # e.g. Pragma or Authorization headers. Values are case insensitive.
5362 # The presence of such a header overrides the cache_mode setting.
5363 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
5364 # Values are case-insensitive.
5365 },
5366 ],
5367 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
5368 # CDN.
5369 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
5370 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
5371 &quot;A String&quot;,
5372 ],
5373 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
5374 # The name=value pair will be used in the cache key Cloud CDN generates.
5375 &quot;A String&quot;,
5376 ],
5377 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
5378 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
5379 # query_string_whitelist and query_string_blacklist. If neither is set, the
5380 # entire query string will be included. If false, the query string will be
5381 # excluded from the cache key entirely.
5382 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
5383 # parameters will be included. Either specify query_string_whitelist or
5384 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
5385 # not treated as delimiters.
5386 &quot;A String&quot;,
5387 ],
5388 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
5389 # parameters will be excluded. Either specify query_string_whitelist or
5390 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
5391 # not treated as delimiters.
5392 &quot;A String&quot;,
5393 ],
5394 },
5395 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
5396 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
5397 # headers to cache content. Responses without these headers will not be
5398 # cached at Google&#x27;s edge, and will require a full trip to the origin on
5399 # every request, potentially impacting performance and increasing load on
5400 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
5401 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
5402 # Warning: this may result in Cloud CDN caching private,
5403 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
5404 # including common image formats, media (video and audio), and web assets
5405 # (JavaScript and CSS). Requests and responses that are marked as
5406 # uncacheable, as well as dynamic content (including HTML), will not be
5407 # cached.
5408 #
5409 # If no value is provided for cdnPolicy.cacheMode, it defaults
5410 # to CACHE_ALL_STATIC.
5411 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
5412 # used to clamp the max-age (or Expires) value sent to the client. With
5413 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
5414 # response max-age directive, along with a &quot;public&quot; directive. For
5415 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
5416 # from the origin (if specified), or else sets the response max-age
5417 # directive to the lesser of the client_ttl and default_ttl, and also
5418 # ensures a &quot;public&quot; cache-control directive is present.
5419 # If a client TTL is not specified, a default value (1 hour) will be used.
5420 # The maximum allowed value is 31,622,400s (1 year).
5421 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
5422 # responses that do not have an existing valid TTL (max-age or s-maxage).
5423 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5424 # The value of defaultTTL cannot be set to a value greater than that of
5425 # maxTTL, but can be equal.
5426 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
5427 # will overwrite the TTL set in all responses. The maximum allowed value is
5428 # 31,622,400s (1 year), noting that infrequently accessed objects may be
5429 # evicted from the cache before the defined TTL.
5430 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
5431 # origin.
5432 # Cache directives that attempt to set a max-age or s-maxage higher than
5433 # this, or an Expires header more than maxTTL seconds in the future will
5434 # be capped at the value of maxTTL, as if it were the value of an
5435 # s-maxage Cache-Control directive.
5436 # Headers sent to the client will not be modified.
5437 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5438 # The maximum allowed value is 31,622,400s (1 year), noting that
5439 # infrequently accessed objects may be evicted from the cache before
5440 # the defined TTL.
5441 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
5442 # to apply fine-grained caching for common errors or redirects.
5443 # This can reduce the load on your origin and improve end-user
5444 # experience by reducing response latency.
5445 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
5446 # negative caching applies to responses with the specified response code
5447 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
5448 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
5449 # to all responses with the specified response code, and override any
5450 # caching headers.
5451 # By default, Cloud CDN will apply the following default TTLs to these
5452 # status codes:
5453 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
5454 # HTTP 404 (Not Found), 410 (Gone),
5455 # 451 (Unavailable For Legal Reasons): 120s
5456 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
5457 # These defaults can be overridden in negative_caching_policy.
5458 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
5459 # negative_caching must be enabled to configure negative_caching_policy.
5460 # Omitting the policy and leaving negative_caching enabled will use
5461 # Cloud CDN&#x27;s default cache TTLs.
5462 # Note that when specifying an explicit negative_caching_policy, you
5463 # should take care to specify a cache TTL for all response codes
5464 # that you wish to cache. Cloud CDN will not apply any default
5465 # negative caching when a policy exists.
5466 { # Specify CDN TTLs for response error codes.
5467 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
5468 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
5469 # specified as values, and you cannot specify a status code more than
5470 # once.
5471 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
5472 # corresponding status code.
5473 # The maximum allowed value is 1800s (30 minutes), noting that
5474 # infrequently accessed objects may be evicted from the cache before the
5475 # defined TTL.
5476 },
5477 ],
5478 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
5479 # requests into a small number of requests to the origin.
5480 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
5481 # content with the origin, or when an error is encountered when refreshing
5482 # the cache.
5483 # This setting defines the default &quot;max-stale&quot; duration for any cached
5484 # responses that do not specify a max-stale directive. Stale responses that
5485 # exceed the TTL configured here will not be served. The default limit
5486 # (max-stale) is 86400s (1 day), which will allow stale content to be
5487 # served up to this limit beyond the max-age (or s-maxage) of a cached
5488 # response.
5489 # The maximum allowed value is 604800 (1 week).
5490 # Set this to zero (0) to disable serve-while-stale.
5491 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
5492 # considered fresh. After this time period, the response will be
5493 # revalidated before being served. Defaults to 1hr (3600s). When serving
5494 # responses to signed URL requests, Cloud CDN will internally behave as
5495 # though all responses from this backend had a &quot;Cache-Control:
5496 # public, max-age=[TTL]&quot; header, regardless of any existing
5497 # Cache-Control header. The actual headers served in responses will not be
5498 # altered.
5499 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
5500 &quot;A String&quot;,
5501 ],
5502 },
5503 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
5504 # backend service.
5505 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
5506 # there is no limit.
5507 #
5508 # Not supported when the backend service is referenced by a URL map that is
5509 # bound to target gRPC proxy that has validateForProxyless field set to true.
5510 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
5511 # not specified, there is no limit.
5512 #
5513 # Not supported when the backend service is referenced by a URL map that is
5514 # bound to target gRPC proxy that has validateForProxyless field set to true.
5515 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
5516 # service. If not specified, there is no limit.
5517 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
5518 # This parameter is respected by both the HTTP/1.1 and HTTP/2
5519 # implementations. If not specified, there is no limit. Setting this
5520 # parameter to 1 will effectively disable keep alive.
5521 #
5522 # Not supported when the backend service is referenced by a URL map that is
5523 # bound to target gRPC proxy that has validateForProxyless field set to true.
5524 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
5525 # not specified, the default is 1.
5526 #
5527 # Not supported when the backend service is referenced by a URL map that is
5528 # bound to target gRPC proxy that has validateForProxyless field set to true.
5529 },
5530 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
5531 # the client&#x27;s Accept-Encoding header.
5532 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
5533 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
5534 # instance. For supported load balancers and protocols, as described inEnabling
5535 # connection draining.
5536 },
5537 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
5538 # tracking policy settings are only available for external passthrough
5539 # Network Load Balancers and internal passthrough Network Load Balancers.
5540 #
5541 # connectionTrackingPolicy cannot be specified with haPolicy.
5542 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
5543 # value is DEFAULT_FOR_PROTOCOL.
5544 #
5545 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
5546 # persist on unhealthy backends only for connection-oriented protocols
5547 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
5548 # Affinity is configured for 5-tuple. They do not persist forUDP.
5549 #
5550 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
5551 # the existing connections on the unhealthy backend are never persisted on
5552 # the unhealthy backend. They are always diverted to newly selected healthy
5553 # backends (unless all backends are unhealthy).
5554 #
5555 # If set to ALWAYS_PERSIST, existing connections always
5556 # persist on unhealthy backends regardless of protocol and session
5557 # affinity. It is generally not recommended to use this mode overriding the
5558 # default.
5559 #
5560 # For more details, see [Connection Persistence for Network Load
5561 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
5562 # and [Connection Persistence for Internal TCP/UDP Load
5563 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
5564 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
5565 # Balancers. This option is not available publicly.
5566 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
5567 # matching traffic (in seconds).
5568 #
5569 # For internal passthrough Network Load Balancers:
5570 #
5571 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
5572 # - It can be set only if Connection Tracking is less than 5-tuple
5573 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
5574 # Mode is PER_SESSION).
5575 #
5576 #
5577 #
5578 # For external passthrough Network Load Balancers the default is 60
5579 # seconds. This option is not available publicly.
5580 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
5581 # options:
5582 #
5583 # - PER_CONNECTION: This is the default mode. The Connection
5584 # Tracking is performed as per the Connection Key (default Hash Method) for
5585 # the specific protocol.
5586 # - PER_SESSION: The Connection Tracking is performed as per
5587 # the configured Session Affinity. It matches the configured Session
5588 # Affinity.
5589 #
5590 #
5591 #
5592 # For more details, see [Tracking Mode for Network Load
5593 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
5594 # and [Tracking Mode for Internal TCP/UDP Load
5595 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
5596 },
5597 &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
5598 # affinity based on HTTP headers, cookies or other properties. This load
5599 # balancing policy is applicable only for HTTP connections. The affinity to a
5600 # particular destination host will be lost when one or more hosts are
5601 # added/removed from the destination service. This field specifies parameters
5602 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
5603 #
5604 # This field is applicable to either:
5605 #
5606 # - A regional backend service with the service protocol set to HTTP,
5607 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
5608 # INTERNAL_MANAGED.
5609 # - A global backend service with the
5610 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5611 &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
5612 # be used as the hash key for the consistent hash load balancer. If the
5613 # cookie is not present, it will be generated. This field is applicable if
5614 # the sessionAffinity is set to HTTP_COOKIE.
5615 #
5616 # Not supported when the backend service is referenced by a URL map that is
5617 # bound to target gRPC proxy that has validateForProxyless field set to true.
5618 # for load balancing policies that use a consistent hash.
5619 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
5620 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
5621 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
5622 # as a count of seconds and fractions of seconds at nanosecond
5623 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5624 # or &quot;month&quot;. Range is approximately 10,000 years.
5625 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5626 # Durations less than one second are represented with a 0
5627 # `seconds` field and a positive `nanos` field. Must be from 0
5628 # to 999,999,999 inclusive.
5629 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5630 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5631 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5632 },
5633 },
5634 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
5635 # applicable if the sessionAffinity is set toHEADER_FIELD.
5636 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
5637 # 1024. Larger ring sizes result in more granular load distributions. If the
5638 # number of hosts in the load balancing pool is larger than the ring size,
5639 # each host will be assigned a single virtual node.
5640 },
5641 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5642 # text format.
5643 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
5644 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
5645 # locality_lb_policy.
5646 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
5647 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5648 # long and match the regular expression
5649 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5650 # first character must be a lowercase letter, and all following
5651 # characters must be a dash, period, underscore, lowercase letter, or
5652 # digit, except the last character, which cannot be a dash, period, or
5653 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5654 # field can only be used for a global or regional backend service with the
5655 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5656 },
5657 ],
5658 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
5659 # custom
5660 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5661 &quot;A String&quot;,
5662 ],
5663 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
5664 # custom
5665 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5666 &quot;A String&quot;,
5667 ],
5668 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5669 # create the resource.
5670 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
5671 # this backend service.
5672 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
5673 # global external Application Load Balancer.
5674 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
5675 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
5676 #
5677 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
5678 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
5679 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
5680 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
5681 # externalManagedMigrationTestingPercentage.
5682 #
5683 # Rolling back a migration requires the states to be set in reverse order. So
5684 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
5685 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
5686 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
5687 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
5688 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
5689 # external Application Load Balancer.
5690 #
5691 # The value of this field must be in the range [0, 100].
5692 #
5693 # Session affinity options will slightly affect this routing behavior, for
5694 # more details, see:Session
5695 # Affinity.
5696 #
5697 # This value can only be set if the loadBalancingScheme in the BackendService
5698 # is set to EXTERNAL (when using the classic Application Load Balancer) and
5699 # the migration state is TEST_BY_PERCENTAGE.
5700 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
5701 # as a backup (failover) backend.
5702 # For load balancers that have configurable failover:
5703 # [Internal passthrough Network Load
5704 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5705 # and [external passthrough Network Load
5706 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5707 #
5708 # failoverPolicy cannot be specified with haPolicy.
5709 # failover:
5710 # [Internal passthrough Network Load
5711 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5712 # and [external passthrough
5713 # Network Load
5714 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5715 # On failover or failback, this field indicates whether connection draining
5716 # will be honored. Google Cloud has a fixed connection draining timeout of
5717 # 10 minutes. A setting of true terminates existing TCP
5718 # connections to the active pool during failover and failback, immediately
5719 # draining traffic. A setting of false allows existing TCP
5720 # connections to persist, even on VMs no longer in the active pool, for up
5721 # to the duration of the connection draining timeout (10 minutes).
5722 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
5723 #
5724 # The default is false.
5725 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
5726 # load balancer are dropped when all primary and all backup backend VMs are
5727 # unhealthy.If set to false, connections are distributed
5728 # among all primary VMs when all primary and all backup backend VMs are
5729 # unhealthy.
5730 # For load balancers that have configurable
5731 # failover:
5732 # [Internal passthrough
5733 # Network Load
5734 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5735 # and [external passthrough
5736 # Network Load
5737 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5738 # The default is false.
5739 &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
5740 # failover when the number of healthy primary VMs equals zero.
5741 # For all other values, the load balancer performs a failover when the
5742 # total number of healthy primary VMs is less than this ratio.
5743 # For load balancers that have configurable
5744 # failover:
5745 # [Internal TCP/UDP Load
5746 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5747 # and [external TCP/UDP Load
5748 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5749 },
5750 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
5751 # This field is used in optimistic locking. This field will be ignored when
5752 # inserting a BackendService. An up-to-date fingerprint must be provided in
5753 # order to update the BackendService, otherwise the request will
5754 # fail with error 412 conditionNotMet.
5755 #
5756 # To see the latest fingerprint, make a get() request to
5757 # retrieve a BackendService.
5758 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
5759 # Protocol Forwarding.
5760 #
5761 # The backends of this regional backend service must only specify zonal
5762 # network endpoint groups (NEGs) of type GCE_VM_IP.
5763 #
5764 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
5765 # regional backend service must set the network field. All zonal NEGs must
5766 # belong to the same network. However, individual NEGs can
5767 # belong to different subnetworks of that network.
5768 #
5769 # When haPolicy is specified, the set of attached network endpoints across
5770 # all backends comprise an High Availability domain from which one endpoint
5771 # is selected as the active endpoint (the leader) that receives all
5772 # traffic.
5773 #
5774 # haPolicy can be added only at backend service creation time. Once set up,
5775 # it cannot be deleted.
5776 #
5777 # Note that haPolicy is not for load balancing, and therefore cannot be
5778 # specified with sessionAffinity, connectionTrackingPolicy, and
5779 # failoverPolicy.
5780 #
5781 # haPolicy requires customers to be responsible for tracking backend
5782 # endpoint health and electing a leader among the healthy endpoints.
5783 # Therefore, haPolicy cannot be specified with healthChecks.
5784 #
5785 # haPolicy can only be specified for External Passthrough Network Load
5786 # Balancers and Internal Passthrough Network Load Balancers.
5787 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
5788 # achieve it.
5789 #
5790 # Supported values are:
5791 #
5792 # - DISABLED: Fast IP Move is disabled. You can only use the
5793 # haPolicy.leader API to update the leader.
5794 # - &gt;GARP_RA: Provides a method to very quickly define a new network
5795 # endpoint as the leader. This method is faster than updating the leader
5796 # using the haPolicy.leader API. Fast IP move works as follows: The VM
5797 # hosting the network endpoint that should become the new leader sends
5798 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
5799 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
5800 # temporarily associates the forwarding rule IP address with that VM, and
5801 # both new and in-flight packets are quickly delivered to that VM.
5802 #
5803 #
5804 #
5805 # Note the important properties of the Fast IP Move functionality:
5806 #
5807 # - The GARP/RA-initiated re-routing stays active for approximately 20
5808 # minutes. After triggering fast failover, you must also
5809 # appropriately set the haPolicy.leader.
5810 # - The new leader instance should continue to send GARP/RA packets
5811 # periodically every 10 seconds until at least 10 minutes after updating
5812 # the haPolicy.leader (but stop immediately if it is no longer the leader).
5813 # - After triggering a fast failover, we recommend that you wait at least
5814 # 3 seconds before sending another GARP/RA packet from a different VM
5815 # instance to avoid race conditions.
5816 # - Don&#x27;t send GARP/RA packets from different VM
5817 # instances at the same time. If multiple instances continue to send
5818 # GARP/RA packets, traffic might be routed to different destinations in an
5819 # alternating order. This condition ceases when a single instance
5820 # issues a GARP/RA packet.
5821 # - The GARP/RA request always takes priority over the leader API.
5822 # Using the haPolicy.leader API to change the leader to a different
5823 # instance will have no effect until the GARP/RA request becomes
5824 # inactive.
5825 # - The GARP/RA packets should follow the GARP/RA
5826 # Packet Specifications..
5827 # - When multiple forwarding rules refer to a regional backend service,
5828 # you need only send a GARP or RA packet for a single forwarding rule
5829 # virtual IP. The virtual IPs for all forwarding rules targeting the same
5830 # backend service will also be moved to the sender of the GARP or RA
5831 # packet.
5832 #
5833 #
5834 #
5835 # The following are the Fast IP Move limitations (that is, when fastIPMove
5836 # is not DISABLED):
5837 #
5838 # - Multiple forwarding rules cannot use the same IP address if one of
5839 # them refers to a regional backend service with fastIPMove.
5840 # - The regional backend service must set the network field, and all
5841 # NEGs must belong to that network. However, individual
5842 # NEGs can belong to different subnetworks of that network.
5843 # - The maximum number of network endpoints across all backends of a
5844 # backend service with fastIPMove is 32.
5845 # - The maximum number of backend services with fastIPMove that can have
5846 # the same network endpoint attached to one of its backends is 64.
5847 # - The maximum number of backend services with fastIPMove in a VPC in a
5848 # region is 64.
5849 # - The network endpoints that are attached to a backend of a backend
5850 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
5851 # - Traffic directed to the leader by a static route next hop will not be
5852 # redirected to a new leader by fast failover. Such traffic will only be
5853 # redirected once an haPolicy.leader update has taken effect. Only traffic
5854 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
5855 # fast failover.
5856 #
5857 #
5858 # haPolicy.fastIPMove can be set only at backend service creation time.
5859 # Once set, it cannot be updated.
5860 #
5861 # By default, fastIpMove is set to DISABLED.
5862 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
5863 # this service as the active endpoint (the leader) that receives all
5864 # traffic.
5865 #
5866 # When the leader changes, there is no connection draining to persist
5867 # existing connections on the old leader.
5868 #
5869 # You are responsible for selecting a suitable endpoint as the
5870 # leader. For example, preferring a healthy endpoint over unhealthy ones.
5871 # Note that this service does not track backend endpoint health, and
5872 # selects the configured leader unconditionally.
5873 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
5874 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
5875 # that the leader is attached to.
5876 #
5877 # The leader&#x27;s backendGroup must already be specified as a backend of
5878 # this backend service. Removing a backend that is designated as the
5879 # leader&#x27;s backendGroup is not permitted.
5880 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
5881 # designated as the leader.
5882 #
5883 # This network endpoint cannot be detached from the NEG specified in
5884 # the haPolicy.leader.backendGroup until the leader is updated with
5885 # another network endpoint, or the leader is removed from the haPolicy.
5886 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
5887 # instance must already be attached to the NEG specified in the
5888 # haPolicy.leader.backendGroup.
5889 #
5890 # The name must be 1-63 characters long, and comply with RFC1035.
5891 # Authorization requires the following IAM permission on the
5892 # specified resource instance: compute.instances.use
5893 },
5894 },
5895 },
5896 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
5897 # httpsHealthChecks (legacy) resource for health checking this backend
5898 # service. Not all backend services support legacy health checks. See
5899 # Load balancer guide. Currently, at most one health check can be
5900 # specified for each backend service. Backend services with
5901 # instance group or zonal NEG backends must have a health check unless
5902 # haPolicy is specified. Backend services with internet or serverless NEG
5903 # backends must not have a health check.
5904 #
5905 # healthChecks[] cannot be specified with haPolicy.
5906 &quot;A String&quot;,
5907 ],
5908 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
5909 # Not available for internal passthrough Network Load Balancers and external
5910 # passthrough Network Load Balancers.
5911 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
5912 # incoming requests.
5913 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
5914 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
5915 # For security reasons, this value cannot be retrieved via the API.
5916 # Instead, the SHA-256 hash of the value is returned in the
5917 # oauth2ClientSecretSha256 field.
5918 #
5919 # @InputOnly
5920 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
5921 },
5922 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5923 # defined by the server.
5924 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
5925 # from the client to the backend for proxyless gRPC).
5926 # The possible values are:
5927 #
5928 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
5929 # backend service (Instance Group, Managed Instance Group, Network Endpoint
5930 # Group), regardless of traffic from the client to the proxy. Only IPv4
5931 # health checks are used to check the health of the backends. This is the
5932 # default setting.
5933 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
5934 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
5935 # address).
5936 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
5937 # backend service (Instance Group, Managed Instance Group, Network Endpoint
5938 # Group), regardless of traffic from the client to the proxy. Only IPv6
5939 # health checks are used to check the health of the backends.
5940 #
5941 #
5942 #
5943 # This field is applicable to either:
5944 #
5945 # - Advanced global external Application Load Balancer (load balancing
5946 # scheme EXTERNAL_MANAGED),
5947 # - Regional external Application Load
5948 # Balancer,
5949 # - Internal proxy Network Load Balancer (load balancing
5950 # scheme INTERNAL_MANAGED),
5951 # - Regional internal Application Load
5952 # Balancer (load balancing scheme INTERNAL_MANAGED),
5953 # - Traffic
5954 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
5955 # INTERNAL_SELF_MANAGED).
5956 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
5957 # for backend services.
5958 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
5959 # created for one type of load balancer cannot be used with another.
5960 # For more information, refer toChoosing
5961 # a load balancer.
5962 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
5963 # preference. When you use localityLbPolicies, you must set at least one
5964 # value for either the localityLbPolicies[].policy or the
5965 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
5966 # value set in the localityLbPolicy field.
5967 #
5968 # For an example of how to use this field, seeDefine
5969 # a list of preferred policies.
5970 #
5971 # Caution: This field and its children are intended for use in a service mesh
5972 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
5973 # that have this configuration.
5974 { # Container for either a built-in LB policy supported by gRPC or Envoy or
5975 # a custom one implemented by the end user.
5976 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
5977 # deployed with the client.
5978 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
5979 # by a locally installed custom policy implementation.
5980 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
5981 #
5982 # The value should match the name of a custom implementation registered
5983 # on the gRPC clients. It should follow protocol buffer message naming
5984 # conventions and include the full path (for example,
5985 # myorg.CustomLbPolicy). The maximum length is 256 characters.
5986 #
5987 # Do not specify the same custom policy more than once for a
5988 # backend. If you do, the configuration is rejected.
5989 #
5990 # For an example of how to use this field, seeUse
5991 # a custom policy.
5992 },
5993 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
5994 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
5995 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
5996 # about these values, see the description of localityLbPolicy.
5997 #
5998 # Do not specify the same policy more than once for a
5999 # backend. If you do, the configuration is rejected.
6000 },
6001 },
6002 ],
6003 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
6004 # possible values are:
6005 #
6006 # - ROUND_ROBIN: This is a simple policy in which each healthy
6007 # backend is selected in round robin order. This is the default.
6008 # - LEAST_REQUEST: An O(1) algorithm which
6009 # selects two random healthy hosts and picks the host which has fewer active
6010 # requests.
6011 # - RING_HASH: The ring/modulo hash load balancer implements
6012 # consistent hashing to backends. The algorithm has the property that the
6013 # addition/removal of a host from a set of N hosts only affects 1/N of the
6014 # requests.
6015 # - RANDOM: The load balancer selects a random healthy
6016 # host.
6017 # - ORIGINAL_DESTINATION: Backend host is selected
6018 # based on the client connection metadata, i.e., connections are opened to
6019 # the same address as the destination address of the incoming connection
6020 # before the connection was redirected to the load balancer.
6021 # - MAGLEV: used as a drop in replacement for the ring hash
6022 # load balancer. Maglev is not as stable as ring hash but has faster table
6023 # lookup build times and host selection times. For more information about
6024 # Maglev, see Maglev:
6025 # A Fast and Reliable Software Network Load Balancer.
6026 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
6027 # Load Balancing using weights computed from Backend reported Custom Metrics.
6028 # If set, the Backend Service responses are expected to contain non-standard
6029 # HTTP response header field Endpoint-Load-Metrics. The reported
6030 # metrics to use for computing the weights are specified via thecustomMetrics field.
6031 #
6032 # This field is applicable to either:
6033 # - A regional backend service with the service protocol set to HTTP,
6034 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6035 # INTERNAL_MANAGED.
6036 # - A global backend service with the
6037 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
6038 # EXTERNAL_MANAGED.
6039 #
6040 #
6041 # If sessionAffinity is not configured—that is, if session
6042 # affinity remains at the default value of NONE—then the
6043 # default value for localityLbPolicy
6044 # is ROUND_ROBIN. If session affinity is set to a value other
6045 # than NONE,
6046 # then the default value for localityLbPolicy isMAGLEV.
6047 #
6048 # Only ROUND_ROBIN and RING_HASH are supported
6049 # when the backend service is referenced by a URL map that is bound to
6050 # target gRPC proxy that has validateForProxyless field set to true.
6051 #
6052 # localityLbPolicy cannot be specified with haPolicy.
6053 &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
6054 # by this backend service. If logging is enabled, logs will be exported to
6055 # Stackdriver.
6056 # backend service.
6057 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
6058 # traffic served by this backend service. The default value is false.
6059 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
6060 { # Determines which HTTP headers will be logged to Stackdriver.
6061 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6062 },
6063 ],
6064 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
6065 { # Determines which HTTP headers will be logged to Stackdriver.
6066 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6067 },
6068 ],
6069 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
6070 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
6071 # of optional fields you want to include in the logs. For example:
6072 # serverInstance, serverGkeDetails.cluster,
6073 # serverGkeDetails.pod.podNamespace
6074 &quot;A String&quot;,
6075 ],
6076 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
6077 # service. Configures whether all, none or a subset of optional fields
6078 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
6079 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
6080 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
6081 # service. The value of the field must be in [0, 1]. This configures the
6082 # sampling rate of requests to the load balancer where 1.0 means all logged
6083 # requests are reported and 0.0 means no logged requests are reported. The
6084 # default value is 1.0.
6085 },
6086 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
6087 # service. Duration is computed from the beginning of the stream until the
6088 # response has been completely processed, including all retries. A stream
6089 # that does not complete in this duration is closed.
6090 #
6091 # If not specified, there will be no timeout limit, i.e. the maximum
6092 # duration is infinite.
6093 #
6094 # This value can be overridden in the PathMatcher configuration of the
6095 # UrlMap that references this backend service.
6096 #
6097 # This field is only allowed when the loadBalancingScheme of
6098 # the backend service is INTERNAL_SELF_MANAGED.
6099 # as a count of seconds and fractions of seconds at nanosecond
6100 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6101 # or &quot;month&quot;. Range is approximately 10,000 years.
6102 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6103 # Durations less than one second are represented with a 0
6104 # `seconds` field and a positive `nanos` field. Must be from 0
6105 # to 999,999,999 inclusive.
6106 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6107 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6108 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6109 },
6110 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
6111 # controller and read by the backend RCTH
6112 &quot;a_key&quot;: &quot;A String&quot;,
6113 },
6114 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6115 # The name must be 1-63 characters long, and comply withRFC1035.
6116 # Specifically, the name must be 1-63 characters long and match the regular
6117 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6118 # character must be a lowercase letter, and all following characters must
6119 # be a dash, lowercase letter, or digit, except the last character, which
6120 # cannot be a dash.
6121 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
6122 #
6123 # This field must be set for Internal Passthrough Network Load Balancers when
6124 # the haPolicy is enabled, and for External Passthrough Network Load
6125 # Balancers when the haPolicy fastIpMove is enabled.
6126 #
6127 # 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.
6128 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
6129 # Load Balancers.
6130 #
6131 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
6132 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
6133 # endpoints in the local zone.
6134 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
6135 # possible values are:
6136 #
6137 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
6138 # is disabled. The load balancer distributes new connections to all
6139 # healthy backend endpoints across all zones.
6140 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
6141 # enabled. The load balancer distributes new connections to all healthy
6142 # backend endpoints in the local zone only. If there are no healthy
6143 # backend endpoints in the local zone, the load balancer distributes
6144 # new connections to all backend endpoints in the local zone.
6145 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
6146 # enabled. The load balancer distributes new connections to all healthy
6147 # backend endpoints in the local zone only. If there aren&#x27;t enough
6148 # healthy backend endpoints in the local zone, the load balancer
6149 # distributes new connections to all healthy backend endpoints across all
6150 # zones.
6151 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
6152 # of healthy backend endpoints in a zone to the count of backend
6153 # endpoints in that same zone is equal to or above this threshold, the
6154 # load balancer distributes new connections to all healthy endpoints in
6155 # the local zone only. When the ratio of the count of healthy backend
6156 # endpoints in a zone to the count of backend endpoints in that same
6157 # zone is below this threshold, the load balancer distributes all new
6158 # connections to all healthy endpoints across all zones.
6159 },
6160 },
6161 &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.
6162 # the backend service.
6163 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
6164 # service.
6165 },
6166 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
6167 # load balancing pool of each individual proxy instance that processes the
6168 # traffic for the given backend service. If not set, this feature is
6169 # considered disabled.
6170 #
6171 # Results of the outlier detection algorithm (ejection of endpoints from the
6172 # load balancing pool and returning them back to the pool) are executed
6173 # independently by each proxy instance of the load balancer. In most cases,
6174 # more than one proxy instance handles the traffic received by a backend
6175 # service. Thus, it is possible that an unhealthy endpoint is detected and
6176 # ejected by only some of the proxies, and while this happens, other proxies
6177 # may continue to send requests to the same unhealthy endpoint until they
6178 # detect and eject the unhealthy endpoint.
6179 #
6180 # Applicable backend endpoints can be:
6181 #
6182 # - VM instances in an Instance Group
6183 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
6184 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
6185 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
6186 # Functions Services
6187 # - Private Service Connect NEGs, that resolve to
6188 # Google-managed regional API endpoints or managed services published using
6189 # Private Service Connect
6190 #
6191 #
6192 #
6193 # Applicable backend service types can be:
6194 #
6195 # - A global backend service with the loadBalancingScheme set to
6196 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
6197 # - A regional backend
6198 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
6199 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
6200 # supported for Serverless NEGs.
6201 #
6202 #
6203 #
6204 # Not supported when the backend service is referenced by a URL map that is
6205 # bound to target gRPC proxy that has validateForProxyless field set to true.
6206 # pool for the backend service.
6207 &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
6208 # or 30s.
6209 #
6210 # After a backend endpoint is returned back to the load balancing pool, it
6211 # can be ejected again in another ejection analysis. Thus, the total ejection
6212 # time is equal to the base ejection time multiplied by the number of times
6213 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
6214 # as a count of seconds and fractions of seconds at nanosecond
6215 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6216 # or &quot;month&quot;. Range is approximately 10,000 years.
6217 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6218 # Durations less than one second are represented with a 0
6219 # `seconds` field and a positive `nanos` field. Must be from 0
6220 # to 999,999,999 inclusive.
6221 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6222 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6223 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6224 },
6225 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
6226 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
6227 # return code qualifies as an error. Defaults to 5.
6228 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
6229 # connection errors that are mapped to one of those status codes) before a
6230 # consecutive gateway failure ejection occurs. Defaults to 3.
6231 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6232 # outlier status is detected through consecutive 5xx. This setting can be
6233 # used to disable ejection or to ramp it up slowly. Defaults to 0.
6234 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6235 # outlier status is detected through consecutive gateway failures. This
6236 # setting can be used to disable ejection or to ramp it up slowly. Defaults
6237 # to 100.
6238 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6239 # outlier status is detected through success rate statistics. This setting
6240 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
6241 #
6242 # Not supported when the backend service uses Serverless NEG.
6243 &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
6244 # ejections and backend endpoints being returned to service. The interval is
6245 # equal to the number of seconds as defined in
6246 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
6247 # in outlierDetection.interval.nanos. Defaults to 1 second.
6248 # as a count of seconds and fractions of seconds at nanosecond
6249 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6250 # or &quot;month&quot;. Range is approximately 10,000 years.
6251 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6252 # Durations less than one second are represented with a 0
6253 # `seconds` field and a positive `nanos` field. Must be from 0
6254 # to 999,999,999 inclusive.
6255 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6256 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6257 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6258 },
6259 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
6260 # backend service that can be ejected if the ejection conditions are met.
6261 # Defaults to 50%.
6262 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
6263 # enough request volume to detect success rate outliers. If the number of
6264 # backend endpoints is fewer than this setting, outlier detection via success
6265 # rate statistics is not performed for any backend endpoint in the load
6266 # balancing pool. Defaults to 5.
6267 #
6268 # Not supported when the backend service uses Serverless NEG.
6269 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
6270 # (as defined by the interval duration above) to include this backend
6271 # endpoint in success rate based outlier detection. If the volume is lower
6272 # than this setting, outlier detection via success rate statistics is not
6273 # performed for that backend endpoint. Defaults to 100.
6274 #
6275 # Not supported when the backend service uses Serverless NEG.
6276 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
6277 # outlier ejection. The ejection threshold is the difference between the mean
6278 # success rate, and the product of this factor and the standard deviation of
6279 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
6280 # is divided by a thousand to get a double. That is, if the desired factor
6281 # is 1.9, the runtime value should be 1900. Defaults to 1900.
6282 #
6283 # Not supported when the backend service uses Serverless NEG.
6284 },
6285 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6286 # as part of resource payload.
6287 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6288 # Tag keys and values have the same definition as resource
6289 # manager tags. The field is allowed for INSERT
6290 # only. The keys/values to set on the resource should be specified in
6291 # either ID { : } or Namespaced format
6292 # { : }.
6293 # For example the following are valid inputs:
6294 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6295 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6296 # Note:
6297 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6298 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6299 &quot;a_key&quot;: &quot;A String&quot;,
6300 },
6301 },
6302 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
6303 # the backend. The default value is 80.
6304 # For internal passthrough Network Load Balancers and external passthrough
6305 # Network Load Balancers, omit port.
6306 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
6307 # communication to the backend VMs in that group. The
6308 # named port must be [defined on each backend instance
6309 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
6310 # This parameter has no meaning if the backends are NEGs. For internal
6311 # passthrough Network Load Balancers and external passthrough Network Load
6312 # Balancers, omit port_name.
6313 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
6314 # with backends.
6315 #
6316 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
6317 # depending on the chosen load balancer or Traffic Director configuration.
6318 # Refer to the documentation for the load balancers or for Traffic Director
6319 # for more information.
6320 #
6321 # Must be set to GRPC when the backend service is referenced by a URL map
6322 # that is bound to target gRPC proxy.
6323 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
6324 # resides. This field is not applicable to global backend services.
6325 # You must specify this field as part of the HTTP request URL. It is
6326 # not settable as a field in the request body.
6327 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
6328 # backend service.
6329 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
6330 # service. This field is applicable to a global backend service with the
6331 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
6332 &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
6333 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
6334 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
6335 # private storage buckets that support Signature Version 4 for authentication.
6336 # The service name for generating the authentication header will always default
6337 # to &#x27;s3&#x27;.
6338 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
6339 # creating a backend that uses AWS v4 signature authentication, but will not
6340 # be returned as part of the configuration when queried with a REST API GET
6341 # request.
6342 #
6343 # @InputOnly
6344 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
6345 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
6346 # keep track of different iterations of your access key.
6347 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
6348 # the name of the region your cloud uses to host your origin. For example,
6349 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
6350 },
6351 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
6352 # that describes how clients should authenticate with this service&#x27;s
6353 # backends.
6354 #
6355 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
6356 # to INTERNAL_SELF_MANAGED.
6357 #
6358 # If left blank, communications are not encrypted.
6359 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
6360 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
6361 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
6362 # specified values, the communication continues. Otherwise, it fails. This
6363 # additional check enables the client to verify that the server is authorized
6364 # to run the requested service.
6365 #
6366 # Note that the contents of the server
6367 # certificate&#x27;s subjectAltName field are configured by the
6368 # Public Key Infrastructure which provisions server identities.
6369 #
6370 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
6371 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
6372 # mode).
6373 &quot;A String&quot;,
6374 ],
6375 },
6376 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6377 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
6378 #
6379 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
6380 # If set, lists of backends and health checks must be both empty.
6381 &quot;A String&quot;,
6382 ],
6383 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
6384 #
6385 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
6386 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
6387 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
6388 #
6389 # Only NONE and HEADER_FIELD are supported
6390 # when the backend service is referenced by a URL map that is bound to
6391 # target gRPC proxy that has validateForProxyless field set to true.
6392 #
6393 # For more details, see:
6394 # [Session
6395 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
6396 #
6397 # sessionAffinity cannot be specified with haPolicy.
6398 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
6399 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
6400 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6401 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6402 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6403 # as a count of seconds and fractions of seconds at nanosecond
6404 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6405 # or &quot;month&quot;. Range is approximately 10,000 years.
6406 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6407 # Durations less than one second are represented with a 0
6408 # `seconds` field and a positive `nanos` field. Must be from 0
6409 # to 999,999,999 inclusive.
6410 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6411 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6412 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6413 },
6414 },
6415 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
6416 # Currently this is applicable only for Internal TCP/UDP load balancing,
6417 # Internal HTTP(S) load balancing and Traffic Director.
6418 &quot;policy&quot;: &quot;A String&quot;,
6419 },
6420 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
6421 # type of load balancer. For more information see,
6422 # Backend service settings.
6423 # The default is 30 seconds.
6424 # The full range of timeout values allowed goes from 1
6425 # through 2,147,483,647 seconds.
6426 #
6427 # This value can be overridden in the PathMatcher configuration of the
6428 # UrlMap that references this backend service.
6429 #
6430 # Not supported when the backend service is referenced by a URL map that is
6431 # bound to target gRPC proxy that has validateForProxyless field set to true.
6432 # Instead, use maxStreamDuration.
6433 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
6434 # when the backend protocol is SSL, HTTPS or HTTP2.
6435 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
6436 # networksecurity.googleapis.com namespace. Can be used in authenticating
6437 # TLS connections to the backend, as specified by the authenticationMode
6438 # field. Can only be specified if authenticationMode is not NONE.
6439 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
6440 # balancer sends this string as the SNI hostname in the TLS connection to
6441 # the backend, and requires that this string match a Subject Alternative
6442 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
6443 # NEG backend, if the SNI is specified here, the load balancer uses it
6444 # regardless of whether the Regional Internet NEG is specified with FQDN or
6445 # IP address and port. When both sni and subjectAltNames[] are specified,
6446 # the load balancer matches the backend certificate&#x27;s SAN only to
6447 # subjectAltNames[].
6448 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
6449 # verifies during a TLS handshake with the backend. When the server
6450 # presents its X.509 certificate to the Load Balancer, the Load Balancer
6451 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
6452 # match one of the subjectAltNames in the list. This field is limited to 5
6453 # entries. When both sni and subjectAltNames[] are specified, the load
6454 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
6455 { # A Subject Alternative Name that the load balancer matches against the SAN
6456 # field in the TLS certificate provided by the backend, specified as either
6457 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
6458 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
6459 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
6460 },
6461 ],
6462 },
6463 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
6464 {
6465 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
6466 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
6467 # and ForwardingRule.
6468 },
6469 ],
6470 },
6471 ],
6472 &quot;kind&quot;: &quot;compute#usableBackendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend
6473 # services.
6474 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
6475 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
6476 # the query parameter pageToken in the next list request.
6477 # Subsequent list requests will have their own nextPageToken to
6478 # continue paging through the results.
6479 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
6480 &quot;warning&quot;: { # [Output Only] Informational warning message.
6481 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6482 # Engine returns NO_RESULTS_ON_PAGE if there
6483 # are no results in the response.
6484 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6485 # value format. For example:
6486 #
6487 # &quot;data&quot;: [
6488 # {
6489 # &quot;key&quot;: &quot;scope&quot;,
6490 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6491 # }
6492 {
6493 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6494 # returned. For example, for warnings where there are no results in a list
6495 # request for a particular zone, this key might be scope and
6496 # the key value might be the zone name. Other examples might be a key
6497 # indicating a deprecated resource and a suggested replacement, or a
6498 # warning about invalid network settings (for example, if an instance
6499 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6500 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6501 },
6502 ],
6503 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6504 },
6505 }</pre>
6506 </div>
6507
6508 <div class="method">
6509 <code class="details" id="listUsable_next">listUsable_next()</code>
6510 <pre>Retrieves the next page of results.
6511
6512 Args:
6513 previous_request: The request for the previous page. (required)
6514 previous_response: The response from the request for the previous page. (required)
6515
6516 Returns:
6517 A request object that you can call &#x27;execute()&#x27; on to request the next
6518 page. Returns None if there are no more items in the collection.
6519 </pre>
6520 </div>
6521
6522 <div class="method">
6523 <code class="details" id="list_next">list_next()</code>
6524 <pre>Retrieves the next page of results.
6525
6526 Args:
6527 previous_request: The request for the previous page. (required)
6528 previous_response: The response from the request for the previous page. (required)
6529
6530 Returns:
6531 A request object that you can call &#x27;execute()&#x27; on to request the next
6532 page. Returns None if there are no more items in the collection.
6533 </pre>
6534 </div>
6535
6536 <div class="method">
6537 <code class="details" id="patch">patch(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
6538 <pre>Updates the specified regional BackendService resource with the data
6539 included in the request. For more information, see
6540 Understanding backend services This method
6541 supports PATCH semantics and uses the JSON merge
6542 patch format and processing rules.
6543
6544 Args:
6545 project: string, Project ID for this request. (required)
6546 region: string, Name of the region scoping this request. (required)
6547 backendService: string, Name of the BackendService resource to patch. (required)
6548 body: object, The request body.
6549 The object takes the form of:
6550
6551 { # Represents a Backend Service resource.
6552 #
6553 # A backend service defines how Google Cloud load balancers distribute traffic.
6554 # The backend service configuration contains a set of values, such as the
6555 # protocol used to connect to backends, various distribution and session
6556 # settings, health checks, and timeouts. These settings provide fine-grained
6557 # control over how your load balancer behaves. Most of the settings have
6558 # default values that allow for easy configuration if you need to get started
6559 # quickly.
6560 #
6561 # Backend services in Google Compute Engine can be either regionally or
6562 # globally scoped.
6563 #
6564 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
6565 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
6566 #
6567 # For more information, seeBackend
6568 # Services.
6569 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
6570 # Load Balancers and Traffic Director and requires
6571 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
6572 #
6573 # If set to 0, the cookie is non-persistent and lasts only until
6574 # the end of the browser session (or equivalent). The maximum allowed value
6575 # is two weeks (1,209,600).
6576 #
6577 # Not supported when the backend service is referenced by a URL map that is
6578 # bound to target gRPC proxy that has validateForProxyless field set to true.
6579 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
6580 { # Message containing information of one individual backend.
6581 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
6582 # handle additional traffic or is fully loaded. For usage guidelines, see
6583 # Connection balancing mode.
6584 #
6585 # Backends must use compatible balancing modes. For more information, see
6586 # Supported balancing modes and target capacity settings and
6587 # Restrictions and guidance for instance groups.
6588 #
6589 # Note: Currently, if you use the API to configure incompatible balancing
6590 # modes, the configuration might be accepted even though it has no impact
6591 # and is ignored. Specifically, Backend.maxUtilization is ignored when
6592 # Backend.balancingMode is RATE. In the future, this incompatible combination
6593 # will be rejected.
6594 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
6595 # mode.
6596 # The default value is 1, which means the group serves up to
6597 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
6598 # completely drained, offering 0% of its available capacity. The valid ranges
6599 # are 0.0 and [0.1,1.0].
6600 # You cannot configure a setting larger than 0 and smaller than0.1.
6601 # You cannot configure a setting of 0 when there is only one
6602 # backend attached to the backend service.
6603 #
6604 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
6605 # internet NEGs, regional serverless NEGs, and PSC NEGs.
6606 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
6607 # BalancingMode.
6608 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
6609 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
6610 # Monitoring, but is not used for load balancing.
6611 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
6612 # balancing mode. The valid range is [0.0, 1.0].
6613 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6614 # long and match the regular expression
6615 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6616 # first character must be a lowercase letter, and all following
6617 # characters must be a dash, period, underscore, lowercase letter, or
6618 # digit, except the last character, which cannot be a dash, period, or
6619 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6620 # field can only be used for a global or regional backend service with the
6621 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6622 },
6623 ],
6624 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6625 # create the resource.
6626 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
6627 # failover backend can be configured for a given BackendService.
6628 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
6629 # group or network endpoint
6630 # group (NEG) resource. To determine what types of backends a load
6631 # balancer supports, see the [Backend services
6632 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
6633 #
6634 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
6635 # or NEG. Partial URLs are not supported.
6636 #
6637 # If haPolicy is specified, backends must refer to NEG resources of type
6638 # GCE_VM_IP.
6639 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6640 # guidelines, seeConnection
6641 # balancing mode and Utilization
6642 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
6643 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6644 # guidelines, seeConnection
6645 # balancing mode and Utilization
6646 # balancing mode.
6647 #
6648 # Not available if the backend&#x27;s balancingMode isRATE.
6649 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
6650 # For usage guidelines, seeConnection
6651 # balancing mode and Utilization
6652 # balancing mode.
6653 #
6654 # Not available if the backend&#x27;s balancingMode isRATE.
6655 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
6656 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
6657 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
6658 # Not available if backend&#x27;s balancingMode is RATE
6659 # or CONNECTION.
6660 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
6661 # Not available if backend&#x27;s balancingMode is RATE
6662 # or CONNECTION.
6663 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
6664 # usage guidelines, seeRate
6665 # balancing mode and Utilization
6666 # balancing mode.
6667 #
6668 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6669 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6670 # guidelines, seeRate
6671 # balancing mode and Utilization
6672 # balancing mode.
6673 #
6674 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6675 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6676 # guidelines, seeRate
6677 # balancing mode and Utilization
6678 # balancing mode.
6679 #
6680 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6681 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
6682 #
6683 # For usage guidelines, seeUtilization
6684 # balancing mode.
6685 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
6686 # the backend.
6687 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
6688 },
6689 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
6690 # sending traffic to backends with default preference. The possible values
6691 # are:
6692 #
6693 # - PREFERRED: Backends with this preference level will be
6694 # filled up to their capacity limits first, based on RTT.
6695 # - DEFAULT: If preferred backends don&#x27;t have enough
6696 # capacity, backends in this layer would be used and traffic would be
6697 # assigned based on the load balancing algorithm you use. This is the
6698 # default
6699 &quot;trafficDuration&quot;: &quot;A String&quot;,
6700 },
6701 ],
6702 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
6703 # specified load balancer types.
6704 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
6705 # Pragma or Authorization headers. Up to 5 headers can be specified.
6706 # The cache is bypassed for all cdnPolicy.cacheMode settings.
6707 { # Bypass the cache when the specified request headers are present,
6708 # e.g. Pragma or Authorization headers. Values are case insensitive.
6709 # The presence of such a header overrides the cache_mode setting.
6710 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
6711 # Values are case-insensitive.
6712 },
6713 ],
6714 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
6715 # CDN.
6716 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
6717 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
6718 &quot;A String&quot;,
6719 ],
6720 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
6721 # The name=value pair will be used in the cache key Cloud CDN generates.
6722 &quot;A String&quot;,
6723 ],
6724 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
6725 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
6726 # query_string_whitelist and query_string_blacklist. If neither is set, the
6727 # entire query string will be included. If false, the query string will be
6728 # excluded from the cache key entirely.
6729 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
6730 # parameters will be included. Either specify query_string_whitelist or
6731 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6732 # not treated as delimiters.
6733 &quot;A String&quot;,
6734 ],
6735 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
6736 # parameters will be excluded. Either specify query_string_whitelist or
6737 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6738 # not treated as delimiters.
6739 &quot;A String&quot;,
6740 ],
6741 },
6742 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
6743 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
6744 # headers to cache content. Responses without these headers will not be
6745 # cached at Google&#x27;s edge, and will require a full trip to the origin on
6746 # every request, potentially impacting performance and increasing load on
6747 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
6748 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
6749 # Warning: this may result in Cloud CDN caching private,
6750 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
6751 # including common image formats, media (video and audio), and web assets
6752 # (JavaScript and CSS). Requests and responses that are marked as
6753 # uncacheable, as well as dynamic content (including HTML), will not be
6754 # cached.
6755 #
6756 # If no value is provided for cdnPolicy.cacheMode, it defaults
6757 # to CACHE_ALL_STATIC.
6758 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
6759 # used to clamp the max-age (or Expires) value sent to the client. With
6760 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
6761 # response max-age directive, along with a &quot;public&quot; directive. For
6762 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
6763 # from the origin (if specified), or else sets the response max-age
6764 # directive to the lesser of the client_ttl and default_ttl, and also
6765 # ensures a &quot;public&quot; cache-control directive is present.
6766 # If a client TTL is not specified, a default value (1 hour) will be used.
6767 # The maximum allowed value is 31,622,400s (1 year).
6768 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
6769 # responses that do not have an existing valid TTL (max-age or s-maxage).
6770 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6771 # The value of defaultTTL cannot be set to a value greater than that of
6772 # maxTTL, but can be equal.
6773 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
6774 # will overwrite the TTL set in all responses. The maximum allowed value is
6775 # 31,622,400s (1 year), noting that infrequently accessed objects may be
6776 # evicted from the cache before the defined TTL.
6777 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
6778 # origin.
6779 # Cache directives that attempt to set a max-age or s-maxage higher than
6780 # this, or an Expires header more than maxTTL seconds in the future will
6781 # be capped at the value of maxTTL, as if it were the value of an
6782 # s-maxage Cache-Control directive.
6783 # Headers sent to the client will not be modified.
6784 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6785 # The maximum allowed value is 31,622,400s (1 year), noting that
6786 # infrequently accessed objects may be evicted from the cache before
6787 # the defined TTL.
6788 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
6789 # to apply fine-grained caching for common errors or redirects.
6790 # This can reduce the load on your origin and improve end-user
6791 # experience by reducing response latency.
6792 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
6793 # negative caching applies to responses with the specified response code
6794 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
6795 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
6796 # to all responses with the specified response code, and override any
6797 # caching headers.
6798 # By default, Cloud CDN will apply the following default TTLs to these
6799 # status codes:
6800 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
6801 # HTTP 404 (Not Found), 410 (Gone),
6802 # 451 (Unavailable For Legal Reasons): 120s
6803 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
6804 # These defaults can be overridden in negative_caching_policy.
6805 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
6806 # negative_caching must be enabled to configure negative_caching_policy.
6807 # Omitting the policy and leaving negative_caching enabled will use
6808 # Cloud CDN&#x27;s default cache TTLs.
6809 # Note that when specifying an explicit negative_caching_policy, you
6810 # should take care to specify a cache TTL for all response codes
6811 # that you wish to cache. Cloud CDN will not apply any default
6812 # negative caching when a policy exists.
6813 { # Specify CDN TTLs for response error codes.
6814 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
6815 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
6816 # specified as values, and you cannot specify a status code more than
6817 # once.
6818 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
6819 # corresponding status code.
6820 # The maximum allowed value is 1800s (30 minutes), noting that
6821 # infrequently accessed objects may be evicted from the cache before the
6822 # defined TTL.
6823 },
6824 ],
6825 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
6826 # requests into a small number of requests to the origin.
6827 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
6828 # content with the origin, or when an error is encountered when refreshing
6829 # the cache.
6830 # This setting defines the default &quot;max-stale&quot; duration for any cached
6831 # responses that do not specify a max-stale directive. Stale responses that
6832 # exceed the TTL configured here will not be served. The default limit
6833 # (max-stale) is 86400s (1 day), which will allow stale content to be
6834 # served up to this limit beyond the max-age (or s-maxage) of a cached
6835 # response.
6836 # The maximum allowed value is 604800 (1 week).
6837 # Set this to zero (0) to disable serve-while-stale.
6838 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
6839 # considered fresh. After this time period, the response will be
6840 # revalidated before being served. Defaults to 1hr (3600s). When serving
6841 # responses to signed URL requests, Cloud CDN will internally behave as
6842 # though all responses from this backend had a &quot;Cache-Control:
6843 # public, max-age=[TTL]&quot; header, regardless of any existing
6844 # Cache-Control header. The actual headers served in responses will not be
6845 # altered.
6846 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
6847 &quot;A String&quot;,
6848 ],
6849 },
6850 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
6851 # backend service.
6852 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
6853 # there is no limit.
6854 #
6855 # Not supported when the backend service is referenced by a URL map that is
6856 # bound to target gRPC proxy that has validateForProxyless field set to true.
6857 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
6858 # not specified, there is no limit.
6859 #
6860 # Not supported when the backend service is referenced by a URL map that is
6861 # bound to target gRPC proxy that has validateForProxyless field set to true.
6862 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
6863 # service. If not specified, there is no limit.
6864 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
6865 # This parameter is respected by both the HTTP/1.1 and HTTP/2
6866 # implementations. If not specified, there is no limit. Setting this
6867 # parameter to 1 will effectively disable keep alive.
6868 #
6869 # Not supported when the backend service is referenced by a URL map that is
6870 # bound to target gRPC proxy that has validateForProxyless field set to true.
6871 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
6872 # not specified, the default is 1.
6873 #
6874 # Not supported when the backend service is referenced by a URL map that is
6875 # bound to target gRPC proxy that has validateForProxyless field set to true.
6876 },
6877 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
6878 # the client&#x27;s Accept-Encoding header.
6879 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
6880 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
6881 # instance. For supported load balancers and protocols, as described inEnabling
6882 # connection draining.
6883 },
6884 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
6885 # tracking policy settings are only available for external passthrough
6886 # Network Load Balancers and internal passthrough Network Load Balancers.
6887 #
6888 # connectionTrackingPolicy cannot be specified with haPolicy.
6889 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
6890 # value is DEFAULT_FOR_PROTOCOL.
6891 #
6892 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
6893 # persist on unhealthy backends only for connection-oriented protocols
6894 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
6895 # Affinity is configured for 5-tuple. They do not persist forUDP.
6896 #
6897 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
6898 # the existing connections on the unhealthy backend are never persisted on
6899 # the unhealthy backend. They are always diverted to newly selected healthy
6900 # backends (unless all backends are unhealthy).
6901 #
6902 # If set to ALWAYS_PERSIST, existing connections always
6903 # persist on unhealthy backends regardless of protocol and session
6904 # affinity. It is generally not recommended to use this mode overriding the
6905 # default.
6906 #
6907 # For more details, see [Connection Persistence for Network Load
6908 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
6909 # and [Connection Persistence for Internal TCP/UDP Load
6910 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
6911 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
6912 # Balancers. This option is not available publicly.
6913 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
6914 # matching traffic (in seconds).
6915 #
6916 # For internal passthrough Network Load Balancers:
6917 #
6918 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
6919 # - It can be set only if Connection Tracking is less than 5-tuple
6920 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
6921 # Mode is PER_SESSION).
6922 #
6923 #
6924 #
6925 # For external passthrough Network Load Balancers the default is 60
6926 # seconds. This option is not available publicly.
6927 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
6928 # options:
6929 #
6930 # - PER_CONNECTION: This is the default mode. The Connection
6931 # Tracking is performed as per the Connection Key (default Hash Method) for
6932 # the specific protocol.
6933 # - PER_SESSION: The Connection Tracking is performed as per
6934 # the configured Session Affinity. It matches the configured Session
6935 # Affinity.
6936 #
6937 #
6938 #
6939 # For more details, see [Tracking Mode for Network Load
6940 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
6941 # and [Tracking Mode for Internal TCP/UDP Load
6942 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
6943 },
6944 &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
6945 # affinity based on HTTP headers, cookies or other properties. This load
6946 # balancing policy is applicable only for HTTP connections. The affinity to a
6947 # particular destination host will be lost when one or more hosts are
6948 # added/removed from the destination service. This field specifies parameters
6949 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
6950 #
6951 # This field is applicable to either:
6952 #
6953 # - A regional backend service with the service protocol set to HTTP,
6954 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6955 # INTERNAL_MANAGED.
6956 # - A global backend service with the
6957 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
6958 &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
6959 # be used as the hash key for the consistent hash load balancer. If the
6960 # cookie is not present, it will be generated. This field is applicable if
6961 # the sessionAffinity is set to HTTP_COOKIE.
6962 #
6963 # Not supported when the backend service is referenced by a URL map that is
6964 # bound to target gRPC proxy that has validateForProxyless field set to true.
6965 # for load balancing policies that use a consistent hash.
6966 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6967 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6968 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6969 # as a count of seconds and fractions of seconds at nanosecond
6970 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6971 # or &quot;month&quot;. Range is approximately 10,000 years.
6972 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6973 # Durations less than one second are represented with a 0
6974 # `seconds` field and a positive `nanos` field. Must be from 0
6975 # to 999,999,999 inclusive.
6976 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6977 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6978 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6979 },
6980 },
6981 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
6982 # applicable if the sessionAffinity is set toHEADER_FIELD.
6983 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
6984 # 1024. Larger ring sizes result in more granular load distributions. If the
6985 # number of hosts in the load balancing pool is larger than the ring size,
6986 # each host will be assigned a single virtual node.
6987 },
6988 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
6989 # text format.
6990 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
6991 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
6992 # locality_lb_policy.
6993 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
6994 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6995 # long and match the regular expression
6996 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6997 # first character must be a lowercase letter, and all following
6998 # characters must be a dash, period, underscore, lowercase letter, or
6999 # digit, except the last character, which cannot be a dash, period, or
7000 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
7001 # field can only be used for a global or regional backend service with the
7002 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
7003 },
7004 ],
7005 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
7006 # custom
7007 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7008 &quot;A String&quot;,
7009 ],
7010 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
7011 # custom
7012 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7013 &quot;A String&quot;,
7014 ],
7015 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7016 # create the resource.
7017 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
7018 # this backend service.
7019 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
7020 # global external Application Load Balancer.
7021 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
7022 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
7023 #
7024 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
7025 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
7026 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
7027 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
7028 # externalManagedMigrationTestingPercentage.
7029 #
7030 # Rolling back a migration requires the states to be set in reverse order. So
7031 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
7032 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
7033 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
7034 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
7035 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
7036 # external Application Load Balancer.
7037 #
7038 # The value of this field must be in the range [0, 100].
7039 #
7040 # Session affinity options will slightly affect this routing behavior, for
7041 # more details, see:Session
7042 # Affinity.
7043 #
7044 # This value can only be set if the loadBalancingScheme in the BackendService
7045 # is set to EXTERNAL (when using the classic Application Load Balancer) and
7046 # the migration state is TEST_BY_PERCENTAGE.
7047 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
7048 # as a backup (failover) backend.
7049 # For load balancers that have configurable failover:
7050 # [Internal passthrough Network Load
7051 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7052 # and [external passthrough Network Load
7053 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7054 #
7055 # failoverPolicy cannot be specified with haPolicy.
7056 # failover:
7057 # [Internal passthrough Network Load
7058 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7059 # and [external passthrough
7060 # Network Load
7061 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7062 # On failover or failback, this field indicates whether connection draining
7063 # will be honored. Google Cloud has a fixed connection draining timeout of
7064 # 10 minutes. A setting of true terminates existing TCP
7065 # connections to the active pool during failover and failback, immediately
7066 # draining traffic. A setting of false allows existing TCP
7067 # connections to persist, even on VMs no longer in the active pool, for up
7068 # to the duration of the connection draining timeout (10 minutes).
7069 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
7070 #
7071 # The default is false.
7072 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
7073 # load balancer are dropped when all primary and all backup backend VMs are
7074 # unhealthy.If set to false, connections are distributed
7075 # among all primary VMs when all primary and all backup backend VMs are
7076 # unhealthy.
7077 # For load balancers that have configurable
7078 # failover:
7079 # [Internal passthrough
7080 # Network Load
7081 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7082 # and [external passthrough
7083 # Network Load
7084 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7085 # The default is false.
7086 &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
7087 # failover when the number of healthy primary VMs equals zero.
7088 # For all other values, the load balancer performs a failover when the
7089 # total number of healthy primary VMs is less than this ratio.
7090 # For load balancers that have configurable
7091 # failover:
7092 # [Internal TCP/UDP Load
7093 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7094 # and [external TCP/UDP Load
7095 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7096 },
7097 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
7098 # This field is used in optimistic locking. This field will be ignored when
7099 # inserting a BackendService. An up-to-date fingerprint must be provided in
7100 # order to update the BackendService, otherwise the request will
7101 # fail with error 412 conditionNotMet.
7102 #
7103 # To see the latest fingerprint, make a get() request to
7104 # retrieve a BackendService.
7105 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
7106 # Protocol Forwarding.
7107 #
7108 # The backends of this regional backend service must only specify zonal
7109 # network endpoint groups (NEGs) of type GCE_VM_IP.
7110 #
7111 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
7112 # regional backend service must set the network field. All zonal NEGs must
7113 # belong to the same network. However, individual NEGs can
7114 # belong to different subnetworks of that network.
7115 #
7116 # When haPolicy is specified, the set of attached network endpoints across
7117 # all backends comprise an High Availability domain from which one endpoint
7118 # is selected as the active endpoint (the leader) that receives all
7119 # traffic.
7120 #
7121 # haPolicy can be added only at backend service creation time. Once set up,
7122 # it cannot be deleted.
7123 #
7124 # Note that haPolicy is not for load balancing, and therefore cannot be
7125 # specified with sessionAffinity, connectionTrackingPolicy, and
7126 # failoverPolicy.
7127 #
7128 # haPolicy requires customers to be responsible for tracking backend
7129 # endpoint health and electing a leader among the healthy endpoints.
7130 # Therefore, haPolicy cannot be specified with healthChecks.
7131 #
7132 # haPolicy can only be specified for External Passthrough Network Load
7133 # Balancers and Internal Passthrough Network Load Balancers.
7134 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
7135 # achieve it.
7136 #
7137 # Supported values are:
7138 #
7139 # - DISABLED: Fast IP Move is disabled. You can only use the
7140 # haPolicy.leader API to update the leader.
7141 # - &gt;GARP_RA: Provides a method to very quickly define a new network
7142 # endpoint as the leader. This method is faster than updating the leader
7143 # using the haPolicy.leader API. Fast IP move works as follows: The VM
7144 # hosting the network endpoint that should become the new leader sends
7145 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
7146 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
7147 # temporarily associates the forwarding rule IP address with that VM, and
7148 # both new and in-flight packets are quickly delivered to that VM.
7149 #
7150 #
7151 #
7152 # Note the important properties of the Fast IP Move functionality:
7153 #
7154 # - The GARP/RA-initiated re-routing stays active for approximately 20
7155 # minutes. After triggering fast failover, you must also
7156 # appropriately set the haPolicy.leader.
7157 # - The new leader instance should continue to send GARP/RA packets
7158 # periodically every 10 seconds until at least 10 minutes after updating
7159 # the haPolicy.leader (but stop immediately if it is no longer the leader).
7160 # - After triggering a fast failover, we recommend that you wait at least
7161 # 3 seconds before sending another GARP/RA packet from a different VM
7162 # instance to avoid race conditions.
7163 # - Don&#x27;t send GARP/RA packets from different VM
7164 # instances at the same time. If multiple instances continue to send
7165 # GARP/RA packets, traffic might be routed to different destinations in an
7166 # alternating order. This condition ceases when a single instance
7167 # issues a GARP/RA packet.
7168 # - The GARP/RA request always takes priority over the leader API.
7169 # Using the haPolicy.leader API to change the leader to a different
7170 # instance will have no effect until the GARP/RA request becomes
7171 # inactive.
7172 # - The GARP/RA packets should follow the GARP/RA
7173 # Packet Specifications..
7174 # - When multiple forwarding rules refer to a regional backend service,
7175 # you need only send a GARP or RA packet for a single forwarding rule
7176 # virtual IP. The virtual IPs for all forwarding rules targeting the same
7177 # backend service will also be moved to the sender of the GARP or RA
7178 # packet.
7179 #
7180 #
7181 #
7182 # The following are the Fast IP Move limitations (that is, when fastIPMove
7183 # is not DISABLED):
7184 #
7185 # - Multiple forwarding rules cannot use the same IP address if one of
7186 # them refers to a regional backend service with fastIPMove.
7187 # - The regional backend service must set the network field, and all
7188 # NEGs must belong to that network. However, individual
7189 # NEGs can belong to different subnetworks of that network.
7190 # - The maximum number of network endpoints across all backends of a
7191 # backend service with fastIPMove is 32.
7192 # - The maximum number of backend services with fastIPMove that can have
7193 # the same network endpoint attached to one of its backends is 64.
7194 # - The maximum number of backend services with fastIPMove in a VPC in a
7195 # region is 64.
7196 # - The network endpoints that are attached to a backend of a backend
7197 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
7198 # - Traffic directed to the leader by a static route next hop will not be
7199 # redirected to a new leader by fast failover. Such traffic will only be
7200 # redirected once an haPolicy.leader update has taken effect. Only traffic
7201 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
7202 # fast failover.
7203 #
7204 #
7205 # haPolicy.fastIPMove can be set only at backend service creation time.
7206 # Once set, it cannot be updated.
7207 #
7208 # By default, fastIpMove is set to DISABLED.
7209 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
7210 # this service as the active endpoint (the leader) that receives all
7211 # traffic.
7212 #
7213 # When the leader changes, there is no connection draining to persist
7214 # existing connections on the old leader.
7215 #
7216 # You are responsible for selecting a suitable endpoint as the
7217 # leader. For example, preferring a healthy endpoint over unhealthy ones.
7218 # Note that this service does not track backend endpoint health, and
7219 # selects the configured leader unconditionally.
7220 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
7221 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
7222 # that the leader is attached to.
7223 #
7224 # The leader&#x27;s backendGroup must already be specified as a backend of
7225 # this backend service. Removing a backend that is designated as the
7226 # leader&#x27;s backendGroup is not permitted.
7227 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
7228 # designated as the leader.
7229 #
7230 # This network endpoint cannot be detached from the NEG specified in
7231 # the haPolicy.leader.backendGroup until the leader is updated with
7232 # another network endpoint, or the leader is removed from the haPolicy.
7233 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
7234 # instance must already be attached to the NEG specified in the
7235 # haPolicy.leader.backendGroup.
7236 #
7237 # The name must be 1-63 characters long, and comply with RFC1035.
7238 # Authorization requires the following IAM permission on the
7239 # specified resource instance: compute.instances.use
7240 },
7241 },
7242 },
7243 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
7244 # httpsHealthChecks (legacy) resource for health checking this backend
7245 # service. Not all backend services support legacy health checks. See
7246 # Load balancer guide. Currently, at most one health check can be
7247 # specified for each backend service. Backend services with
7248 # instance group or zonal NEG backends must have a health check unless
7249 # haPolicy is specified. Backend services with internet or serverless NEG
7250 # backends must not have a health check.
7251 #
7252 # healthChecks[] cannot be specified with haPolicy.
7253 &quot;A String&quot;,
7254 ],
7255 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
7256 # Not available for internal passthrough Network Load Balancers and external
7257 # passthrough Network Load Balancers.
7258 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
7259 # incoming requests.
7260 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
7261 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
7262 # For security reasons, this value cannot be retrieved via the API.
7263 # Instead, the SHA-256 hash of the value is returned in the
7264 # oauth2ClientSecretSha256 field.
7265 #
7266 # @InputOnly
7267 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
7268 },
7269 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7270 # defined by the server.
7271 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
7272 # from the client to the backend for proxyless gRPC).
7273 # The possible values are:
7274 #
7275 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
7276 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7277 # Group), regardless of traffic from the client to the proxy. Only IPv4
7278 # health checks are used to check the health of the backends. This is the
7279 # default setting.
7280 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
7281 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
7282 # address).
7283 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
7284 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7285 # Group), regardless of traffic from the client to the proxy. Only IPv6
7286 # health checks are used to check the health of the backends.
7287 #
7288 #
7289 #
7290 # This field is applicable to either:
7291 #
7292 # - Advanced global external Application Load Balancer (load balancing
7293 # scheme EXTERNAL_MANAGED),
7294 # - Regional external Application Load
7295 # Balancer,
7296 # - Internal proxy Network Load Balancer (load balancing
7297 # scheme INTERNAL_MANAGED),
7298 # - Regional internal Application Load
7299 # Balancer (load balancing scheme INTERNAL_MANAGED),
7300 # - Traffic
7301 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
7302 # INTERNAL_SELF_MANAGED).
7303 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
7304 # for backend services.
7305 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
7306 # created for one type of load balancer cannot be used with another.
7307 # For more information, refer toChoosing
7308 # a load balancer.
7309 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
7310 # preference. When you use localityLbPolicies, you must set at least one
7311 # value for either the localityLbPolicies[].policy or the
7312 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
7313 # value set in the localityLbPolicy field.
7314 #
7315 # For an example of how to use this field, seeDefine
7316 # a list of preferred policies.
7317 #
7318 # Caution: This field and its children are intended for use in a service mesh
7319 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
7320 # that have this configuration.
7321 { # Container for either a built-in LB policy supported by gRPC or Envoy or
7322 # a custom one implemented by the end user.
7323 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
7324 # deployed with the client.
7325 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
7326 # by a locally installed custom policy implementation.
7327 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
7328 #
7329 # The value should match the name of a custom implementation registered
7330 # on the gRPC clients. It should follow protocol buffer message naming
7331 # conventions and include the full path (for example,
7332 # myorg.CustomLbPolicy). The maximum length is 256 characters.
7333 #
7334 # Do not specify the same custom policy more than once for a
7335 # backend. If you do, the configuration is rejected.
7336 #
7337 # For an example of how to use this field, seeUse
7338 # a custom policy.
7339 },
7340 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
7341 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
7342 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
7343 # about these values, see the description of localityLbPolicy.
7344 #
7345 # Do not specify the same policy more than once for a
7346 # backend. If you do, the configuration is rejected.
7347 },
7348 },
7349 ],
7350 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
7351 # possible values are:
7352 #
7353 # - ROUND_ROBIN: This is a simple policy in which each healthy
7354 # backend is selected in round robin order. This is the default.
7355 # - LEAST_REQUEST: An O(1) algorithm which
7356 # selects two random healthy hosts and picks the host which has fewer active
7357 # requests.
7358 # - RING_HASH: The ring/modulo hash load balancer implements
7359 # consistent hashing to backends. The algorithm has the property that the
7360 # addition/removal of a host from a set of N hosts only affects 1/N of the
7361 # requests.
7362 # - RANDOM: The load balancer selects a random healthy
7363 # host.
7364 # - ORIGINAL_DESTINATION: Backend host is selected
7365 # based on the client connection metadata, i.e., connections are opened to
7366 # the same address as the destination address of the incoming connection
7367 # before the connection was redirected to the load balancer.
7368 # - MAGLEV: used as a drop in replacement for the ring hash
7369 # load balancer. Maglev is not as stable as ring hash but has faster table
7370 # lookup build times and host selection times. For more information about
7371 # Maglev, see Maglev:
7372 # A Fast and Reliable Software Network Load Balancer.
7373 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
7374 # Load Balancing using weights computed from Backend reported Custom Metrics.
7375 # If set, the Backend Service responses are expected to contain non-standard
7376 # HTTP response header field Endpoint-Load-Metrics. The reported
7377 # metrics to use for computing the weights are specified via thecustomMetrics field.
7378 #
7379 # This field is applicable to either:
7380 # - A regional backend service with the service protocol set to HTTP,
7381 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7382 # INTERNAL_MANAGED.
7383 # - A global backend service with the
7384 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
7385 # EXTERNAL_MANAGED.
7386 #
7387 #
7388 # If sessionAffinity is not configured—that is, if session
7389 # affinity remains at the default value of NONE—then the
7390 # default value for localityLbPolicy
7391 # is ROUND_ROBIN. If session affinity is set to a value other
7392 # than NONE,
7393 # then the default value for localityLbPolicy isMAGLEV.
7394 #
7395 # Only ROUND_ROBIN and RING_HASH are supported
7396 # when the backend service is referenced by a URL map that is bound to
7397 # target gRPC proxy that has validateForProxyless field set to true.
7398 #
7399 # localityLbPolicy cannot be specified with haPolicy.
7400 &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
7401 # by this backend service. If logging is enabled, logs will be exported to
7402 # Stackdriver.
7403 # backend service.
7404 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
7405 # traffic served by this backend service. The default value is false.
7406 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
7407 { # Determines which HTTP headers will be logged to Stackdriver.
7408 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7409 },
7410 ],
7411 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
7412 { # Determines which HTTP headers will be logged to Stackdriver.
7413 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7414 },
7415 ],
7416 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
7417 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
7418 # of optional fields you want to include in the logs. For example:
7419 # serverInstance, serverGkeDetails.cluster,
7420 # serverGkeDetails.pod.podNamespace
7421 &quot;A String&quot;,
7422 ],
7423 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
7424 # service. Configures whether all, none or a subset of optional fields
7425 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
7426 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
7427 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
7428 # service. The value of the field must be in [0, 1]. This configures the
7429 # sampling rate of requests to the load balancer where 1.0 means all logged
7430 # requests are reported and 0.0 means no logged requests are reported. The
7431 # default value is 1.0.
7432 },
7433 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
7434 # service. Duration is computed from the beginning of the stream until the
7435 # response has been completely processed, including all retries. A stream
7436 # that does not complete in this duration is closed.
7437 #
7438 # If not specified, there will be no timeout limit, i.e. the maximum
7439 # duration is infinite.
7440 #
7441 # This value can be overridden in the PathMatcher configuration of the
7442 # UrlMap that references this backend service.
7443 #
7444 # This field is only allowed when the loadBalancingScheme of
7445 # the backend service is INTERNAL_SELF_MANAGED.
7446 # as a count of seconds and fractions of seconds at nanosecond
7447 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7448 # or &quot;month&quot;. Range is approximately 10,000 years.
7449 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7450 # Durations less than one second are represented with a 0
7451 # `seconds` field and a positive `nanos` field. Must be from 0
7452 # to 999,999,999 inclusive.
7453 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7454 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7455 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7456 },
7457 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
7458 # controller and read by the backend RCTH
7459 &quot;a_key&quot;: &quot;A String&quot;,
7460 },
7461 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7462 # The name must be 1-63 characters long, and comply withRFC1035.
7463 # Specifically, the name must be 1-63 characters long and match the regular
7464 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7465 # character must be a lowercase letter, and all following characters must
7466 # be a dash, lowercase letter, or digit, except the last character, which
7467 # cannot be a dash.
7468 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
7469 #
7470 # This field must be set for Internal Passthrough Network Load Balancers when
7471 # the haPolicy is enabled, and for External Passthrough Network Load
7472 # Balancers when the haPolicy fastIpMove is enabled.
7473 #
7474 # 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.
7475 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
7476 # Load Balancers.
7477 #
7478 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
7479 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
7480 # endpoints in the local zone.
7481 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
7482 # possible values are:
7483 #
7484 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
7485 # is disabled. The load balancer distributes new connections to all
7486 # healthy backend endpoints across all zones.
7487 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
7488 # enabled. The load balancer distributes new connections to all healthy
7489 # backend endpoints in the local zone only. If there are no healthy
7490 # backend endpoints in the local zone, the load balancer distributes
7491 # new connections to all backend endpoints in the local zone.
7492 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
7493 # enabled. The load balancer distributes new connections to all healthy
7494 # backend endpoints in the local zone only. If there aren&#x27;t enough
7495 # healthy backend endpoints in the local zone, the load balancer
7496 # distributes new connections to all healthy backend endpoints across all
7497 # zones.
7498 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
7499 # of healthy backend endpoints in a zone to the count of backend
7500 # endpoints in that same zone is equal to or above this threshold, the
7501 # load balancer distributes new connections to all healthy endpoints in
7502 # the local zone only. When the ratio of the count of healthy backend
7503 # endpoints in a zone to the count of backend endpoints in that same
7504 # zone is below this threshold, the load balancer distributes all new
7505 # connections to all healthy endpoints across all zones.
7506 },
7507 },
7508 &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.
7509 # the backend service.
7510 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
7511 # service.
7512 },
7513 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
7514 # load balancing pool of each individual proxy instance that processes the
7515 # traffic for the given backend service. If not set, this feature is
7516 # considered disabled.
7517 #
7518 # Results of the outlier detection algorithm (ejection of endpoints from the
7519 # load balancing pool and returning them back to the pool) are executed
7520 # independently by each proxy instance of the load balancer. In most cases,
7521 # more than one proxy instance handles the traffic received by a backend
7522 # service. Thus, it is possible that an unhealthy endpoint is detected and
7523 # ejected by only some of the proxies, and while this happens, other proxies
7524 # may continue to send requests to the same unhealthy endpoint until they
7525 # detect and eject the unhealthy endpoint.
7526 #
7527 # Applicable backend endpoints can be:
7528 #
7529 # - VM instances in an Instance Group
7530 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
7531 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
7532 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
7533 # Functions Services
7534 # - Private Service Connect NEGs, that resolve to
7535 # Google-managed regional API endpoints or managed services published using
7536 # Private Service Connect
7537 #
7538 #
7539 #
7540 # Applicable backend service types can be:
7541 #
7542 # - A global backend service with the loadBalancingScheme set to
7543 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
7544 # - A regional backend
7545 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
7546 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
7547 # supported for Serverless NEGs.
7548 #
7549 #
7550 #
7551 # Not supported when the backend service is referenced by a URL map that is
7552 # bound to target gRPC proxy that has validateForProxyless field set to true.
7553 # pool for the backend service.
7554 &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
7555 # or 30s.
7556 #
7557 # After a backend endpoint is returned back to the load balancing pool, it
7558 # can be ejected again in another ejection analysis. Thus, the total ejection
7559 # time is equal to the base ejection time multiplied by the number of times
7560 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
7561 # as a count of seconds and fractions of seconds at nanosecond
7562 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7563 # or &quot;month&quot;. Range is approximately 10,000 years.
7564 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7565 # Durations less than one second are represented with a 0
7566 # `seconds` field and a positive `nanos` field. Must be from 0
7567 # to 999,999,999 inclusive.
7568 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7569 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7570 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7571 },
7572 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
7573 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
7574 # return code qualifies as an error. Defaults to 5.
7575 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
7576 # connection errors that are mapped to one of those status codes) before a
7577 # consecutive gateway failure ejection occurs. Defaults to 3.
7578 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7579 # outlier status is detected through consecutive 5xx. This setting can be
7580 # used to disable ejection or to ramp it up slowly. Defaults to 0.
7581 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7582 # outlier status is detected through consecutive gateway failures. This
7583 # setting can be used to disable ejection or to ramp it up slowly. Defaults
7584 # to 100.
7585 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7586 # outlier status is detected through success rate statistics. This setting
7587 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
7588 #
7589 # Not supported when the backend service uses Serverless NEG.
7590 &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
7591 # ejections and backend endpoints being returned to service. The interval is
7592 # equal to the number of seconds as defined in
7593 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
7594 # in outlierDetection.interval.nanos. Defaults to 1 second.
7595 # as a count of seconds and fractions of seconds at nanosecond
7596 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7597 # or &quot;month&quot;. Range is approximately 10,000 years.
7598 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7599 # Durations less than one second are represented with a 0
7600 # `seconds` field and a positive `nanos` field. Must be from 0
7601 # to 999,999,999 inclusive.
7602 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7603 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7604 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7605 },
7606 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
7607 # backend service that can be ejected if the ejection conditions are met.
7608 # Defaults to 50%.
7609 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
7610 # enough request volume to detect success rate outliers. If the number of
7611 # backend endpoints is fewer than this setting, outlier detection via success
7612 # rate statistics is not performed for any backend endpoint in the load
7613 # balancing pool. Defaults to 5.
7614 #
7615 # Not supported when the backend service uses Serverless NEG.
7616 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
7617 # (as defined by the interval duration above) to include this backend
7618 # endpoint in success rate based outlier detection. If the volume is lower
7619 # than this setting, outlier detection via success rate statistics is not
7620 # performed for that backend endpoint. Defaults to 100.
7621 #
7622 # Not supported when the backend service uses Serverless NEG.
7623 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
7624 # outlier ejection. The ejection threshold is the difference between the mean
7625 # success rate, and the product of this factor and the standard deviation of
7626 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
7627 # is divided by a thousand to get a double. That is, if the desired factor
7628 # is 1.9, the runtime value should be 1900. Defaults to 1900.
7629 #
7630 # Not supported when the backend service uses Serverless NEG.
7631 },
7632 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7633 # as part of resource payload.
7634 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7635 # Tag keys and values have the same definition as resource
7636 # manager tags. The field is allowed for INSERT
7637 # only. The keys/values to set on the resource should be specified in
7638 # either ID { : } or Namespaced format
7639 # { : }.
7640 # For example the following are valid inputs:
7641 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7642 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7643 # Note:
7644 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7645 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7646 &quot;a_key&quot;: &quot;A String&quot;,
7647 },
7648 },
7649 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
7650 # the backend. The default value is 80.
7651 # For internal passthrough Network Load Balancers and external passthrough
7652 # Network Load Balancers, omit port.
7653 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
7654 # communication to the backend VMs in that group. The
7655 # named port must be [defined on each backend instance
7656 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
7657 # This parameter has no meaning if the backends are NEGs. For internal
7658 # passthrough Network Load Balancers and external passthrough Network Load
7659 # Balancers, omit port_name.
7660 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
7661 # with backends.
7662 #
7663 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
7664 # depending on the chosen load balancer or Traffic Director configuration.
7665 # Refer to the documentation for the load balancers or for Traffic Director
7666 # for more information.
7667 #
7668 # Must be set to GRPC when the backend service is referenced by a URL map
7669 # that is bound to target gRPC proxy.
7670 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
7671 # resides. This field is not applicable to global backend services.
7672 # You must specify this field as part of the HTTP request URL. It is
7673 # not settable as a field in the request body.
7674 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
7675 # backend service.
7676 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
7677 # service. This field is applicable to a global backend service with the
7678 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7679 &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
7680 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
7681 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
7682 # private storage buckets that support Signature Version 4 for authentication.
7683 # The service name for generating the authentication header will always default
7684 # to &#x27;s3&#x27;.
7685 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
7686 # creating a backend that uses AWS v4 signature authentication, but will not
7687 # be returned as part of the configuration when queried with a REST API GET
7688 # request.
7689 #
7690 # @InputOnly
7691 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
7692 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
7693 # keep track of different iterations of your access key.
7694 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
7695 # the name of the region your cloud uses to host your origin. For example,
7696 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
7697 },
7698 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
7699 # that describes how clients should authenticate with this service&#x27;s
7700 # backends.
7701 #
7702 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
7703 # to INTERNAL_SELF_MANAGED.
7704 #
7705 # If left blank, communications are not encrypted.
7706 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
7707 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
7708 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
7709 # specified values, the communication continues. Otherwise, it fails. This
7710 # additional check enables the client to verify that the server is authorized
7711 # to run the requested service.
7712 #
7713 # Note that the contents of the server
7714 # certificate&#x27;s subjectAltName field are configured by the
7715 # Public Key Infrastructure which provisions server identities.
7716 #
7717 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
7718 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
7719 # mode).
7720 &quot;A String&quot;,
7721 ],
7722 },
7723 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7724 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
7725 #
7726 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
7727 # If set, lists of backends and health checks must be both empty.
7728 &quot;A String&quot;,
7729 ],
7730 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
7731 #
7732 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
7733 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
7734 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
7735 #
7736 # Only NONE and HEADER_FIELD are supported
7737 # when the backend service is referenced by a URL map that is bound to
7738 # target gRPC proxy that has validateForProxyless field set to true.
7739 #
7740 # For more details, see:
7741 # [Session
7742 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
7743 #
7744 # sessionAffinity cannot be specified with haPolicy.
7745 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
7746 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
7747 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7748 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7749 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7750 # as a count of seconds and fractions of seconds at nanosecond
7751 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7752 # or &quot;month&quot;. Range is approximately 10,000 years.
7753 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7754 # Durations less than one second are represented with a 0
7755 # `seconds` field and a positive `nanos` field. Must be from 0
7756 # to 999,999,999 inclusive.
7757 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7758 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7759 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7760 },
7761 },
7762 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
7763 # Currently this is applicable only for Internal TCP/UDP load balancing,
7764 # Internal HTTP(S) load balancing and Traffic Director.
7765 &quot;policy&quot;: &quot;A String&quot;,
7766 },
7767 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
7768 # type of load balancer. For more information see,
7769 # Backend service settings.
7770 # The default is 30 seconds.
7771 # The full range of timeout values allowed goes from 1
7772 # through 2,147,483,647 seconds.
7773 #
7774 # This value can be overridden in the PathMatcher configuration of the
7775 # UrlMap that references this backend service.
7776 #
7777 # Not supported when the backend service is referenced by a URL map that is
7778 # bound to target gRPC proxy that has validateForProxyless field set to true.
7779 # Instead, use maxStreamDuration.
7780 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
7781 # when the backend protocol is SSL, HTTPS or HTTP2.
7782 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
7783 # networksecurity.googleapis.com namespace. Can be used in authenticating
7784 # TLS connections to the backend, as specified by the authenticationMode
7785 # field. Can only be specified if authenticationMode is not NONE.
7786 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
7787 # balancer sends this string as the SNI hostname in the TLS connection to
7788 # the backend, and requires that this string match a Subject Alternative
7789 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
7790 # NEG backend, if the SNI is specified here, the load balancer uses it
7791 # regardless of whether the Regional Internet NEG is specified with FQDN or
7792 # IP address and port. When both sni and subjectAltNames[] are specified,
7793 # the load balancer matches the backend certificate&#x27;s SAN only to
7794 # subjectAltNames[].
7795 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
7796 # verifies during a TLS handshake with the backend. When the server
7797 # presents its X.509 certificate to the Load Balancer, the Load Balancer
7798 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
7799 # match one of the subjectAltNames in the list. This field is limited to 5
7800 # entries. When both sni and subjectAltNames[] are specified, the load
7801 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
7802 { # A Subject Alternative Name that the load balancer matches against the SAN
7803 # field in the TLS certificate provided by the backend, specified as either
7804 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
7805 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
7806 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
7807 },
7808 ],
7809 },
7810 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
7811 {
7812 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
7813 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
7814 # and ForwardingRule.
7815 },
7816 ],
7817 }
7818
7819 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7820 that if you must retry your request, the server will know to ignore the
7821 request if it has already been completed.
7822
7823 For example, consider a situation where you make an initial request and
7824 the request times out. If you make the request again with the same
7825 request ID, the server can check if original operation with the same
7826 request ID was received, and if so, will ignore the second request. This
7827 prevents clients from accidentally creating duplicate commitments.
7828
7829 The request ID must be
7830 a valid UUID with the exception that zero UUID is not supported
7831 (00000000-0000-0000-0000-000000000000).
7832 x__xgafv: string, V1 error format.
7833 Allowed values
7834 1 - v1 error format
7835 2 - v2 error format
7836
7837 Returns:
7838 An object of the form:
7839
7840 { # Represents an Operation resource.
7841 #
7842 # Google Compute Engine has three Operation resources:
7843 #
7844 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7845 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7846 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7847 #
7848 # You can use an operation resource to manage asynchronous API requests.
7849 # For more information, readHandling
7850 # API responses.
7851 #
7852 # Operations can be global, regional or zonal.
7853 #
7854 # - For global operations, use the `globalOperations`
7855 # resource.
7856 # - For regional operations, use the
7857 # `regionOperations` resource.
7858 # - For zonal operations, use
7859 # the `zoneOperations` resource.
7860 #
7861 #
7862 #
7863 # For more information, read
7864 # Global, Regional, and Zonal Resources.
7865 #
7866 # Note that completed Operation resources have a limited
7867 # retention period.
7868 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7869 # Not present otherwise.
7870 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7871 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7872 # set when the operation is created.
7873 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7874 # text format.
7875 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7876 # this field will be populated.
7877 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7878 # operation.
7879 {
7880 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7881 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7882 # details. There is a set of defined message types to use for providing
7883 # details.The syntax depends on the error code. For example,
7884 # QuotaExceededInfo will have details when the error code is
7885 # QUOTA_EXCEEDED.
7886 {
7887 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7888 #
7889 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7890 # is not enabled:
7891 #
7892 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7893 # &quot;domain&quot;: &quot;googleapis.com&quot;
7894 # &quot;metadata&quot;: {
7895 # &quot;resource&quot;: &quot;projects/123&quot;,
7896 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7897 # }
7898 # }
7899 #
7900 # This response indicates that the pubsub.googleapis.com API is not enabled.
7901 #
7902 # Example of an error that is returned when attempting to create a Spanner
7903 # instance in a region that is out of stock:
7904 #
7905 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7906 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7907 # &quot;metadata&quot;: {
7908 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7909 # }
7910 # }
7911 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7912 # is typically the registered service name of the tool or product that
7913 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7914 # generated by some common infrastructure, the error domain must be a
7915 # globally unique value that identifies the infrastructure. For Google API
7916 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7917 &quot;metadatas&quot;: { # Additional structured details about this error.
7918 #
7919 # Keys must match a regular expression of `a-z+` but should
7920 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7921 # length. When identifying the current value of an exceeded limit, the units
7922 # should be contained in the key, not the value. For example, rather than
7923 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7924 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7925 # instances that can be created in a single (batch) request.
7926 &quot;a_key&quot;: &quot;A String&quot;,
7927 },
7928 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7929 # proximate cause of the error. Error reasons are unique within a particular
7930 # domain of errors. This should be at most 63 characters and match a
7931 # regular expression of `A-Z+[A-Z0-9]`, which represents
7932 # UPPER_SNAKE_CASE.
7933 },
7934 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7935 #
7936 # For example, if a quota check failed with an error indicating the calling
7937 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7938 # directly to the right place in the developer console to flip the bit.
7939 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7940 { # Describes a URL link.
7941 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7942 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7943 },
7944 ],
7945 },
7946 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7947 # which can be attached to an RPC error.
7948 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7949 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7950 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7951 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7952 },
7953 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7954 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7955 &quot;a_key&quot;: &quot;A String&quot;,
7956 },
7957 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7958 # type or metric.
7959 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7960 # or metric.
7961 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7962 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7963 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7964 },
7965 },
7966 ],
7967 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7968 # This property is optional.
7969 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7970 },
7971 ],
7972 },
7973 &quot;getVersionOperationMetadata&quot;: {
7974 &quot;inlineSbomInfo&quot;: {
7975 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7976 # appropriate identifiers.
7977 &quot;a_key&quot;: &quot;A String&quot;,
7978 },
7979 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7980 # identifiers.
7981 &quot;a_key&quot;: &quot;A String&quot;,
7982 },
7983 },
7984 },
7985 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7986 # message that was returned, such as `NOT FOUND`.
7987 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7988 # status code that was returned. For example, a `404` means the
7989 # resource was not found.
7990 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7991 # defined by the server.
7992 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7993 # This value is inRFC3339
7994 # text format.
7995 &quot;instancesBulkInsertOperationMetadata&quot;: {
7996 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7997 # Example key: zones/us-central1-a
7998 &quot;a_key&quot;: {
7999 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8000 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8001 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8002 # error.
8003 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8004 # if the flow is rolling forward or rolling back.
8005 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8006 },
8007 },
8008 },
8009 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8010 # Operation resources.
8011 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8012 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8013 # group of operations results from a `bulkInsert` API request.
8014 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8015 # `update`, or `delete`, and so on.
8016 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8017 # There is no requirement that this be linear or support any granularity of
8018 # operations. This should not be used to guess when the operation will be
8019 # complete. This number should monotonically increase as the operation
8020 # progresses.
8021 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8022 # applicable when performing regional operations.
8023 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8024 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8025 # this field will contain information on all underlying zonal actions and
8026 # their state.
8027 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8028 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8029 # Example key: zones/us-central1-a
8030 &quot;a_key&quot;: {
8031 &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
8032 # populated.
8033 # different programming environments, including REST APIs and RPC APIs. It is
8034 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8035 # three pieces of data: error code, error message, and error details.
8036 #
8037 # You can find out more about this error model and how to work with it in the
8038 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8039 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8040 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8041 # message types for APIs to use.
8042 {
8043 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8044 },
8045 ],
8046 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8047 # user-facing error message should be localized and sent in the
8048 # google.rpc.Status.details field, or localized by the client.
8049 },
8050 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8051 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8052 },
8053 },
8054 },
8055 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8056 # This value is inRFC3339
8057 # text format.
8058 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8059 # following:
8060 # `PENDING`, `RUNNING`, or `DONE`.
8061 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8062 # operation.
8063 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8064 # of the target resource.
8065 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8066 # operations related to creating a snapshot, this points to the disk
8067 # that the snapshot was created from.
8068 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8069 # `[email protected]` or
8070 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8071 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8072 # operation, this field will be populated.
8073 {
8074 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8075 # Engine returns NO_RESULTS_ON_PAGE if there
8076 # are no results in the response.
8077 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8078 # value format. For example:
8079 #
8080 # &quot;data&quot;: [
8081 # {
8082 # &quot;key&quot;: &quot;scope&quot;,
8083 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8084 # }
8085 {
8086 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8087 # returned. For example, for warnings where there are no results in a list
8088 # request for a particular zone, this key might be scope and
8089 # the key value might be the zone name. Other examples might be a key
8090 # indicating a deprecated resource and a suggested replacement, or a
8091 # warning about invalid network settings (for example, if an instance
8092 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8093 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8094 },
8095 ],
8096 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8097 },
8098 ],
8099 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8100 # applicable when performing per-zone operations.
8101 }</pre>
8102 </div>
8103
8104 <div class="method">
8105 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
8106 <pre>Sets the access control policy on the specified resource.
8107 Replaces any existing policy.
8108
8109 Args:
8110 project: string, Project ID for this request. (required)
8111 region: string, The name of the region for this request. (required)
8112 resource: string, Name or id of the resource for this request. (required)
8113 body: object, The request body.
8114 The object takes the form of:
8115
8116 {
8117 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
8118 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
8119 { # Associates `members`, or principals, with a `role`.
8120 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8121 #
8122 # If the condition evaluates to `true`, then this binding applies to the
8123 # current request.
8124 #
8125 # If the condition evaluates to `false`, then this binding does not apply to
8126 # the current request. However, a different role binding might grant the same
8127 # role to one or more of the principals in this binding.
8128 #
8129 # To learn which resources support conditions in their IAM policies, see the
8130 # [IAM
8131 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8132 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8133 # are documented at https://github.com/google/cel-spec.
8134 #
8135 # Example (Comparison):
8136 #
8137 # title: &quot;Summary size limit&quot;
8138 # description: &quot;Determines if a summary is less than 100 chars&quot;
8139 # expression: &quot;document.summary.size() &lt; 100&quot;
8140 #
8141 # Example (Equality):
8142 #
8143 # title: &quot;Requestor is owner&quot;
8144 # description: &quot;Determines if requestor is the document owner&quot;
8145 # expression: &quot;document.owner == request.auth.claims.email&quot;
8146 #
8147 # Example (Logic):
8148 #
8149 # title: &quot;Public documents&quot;
8150 # description: &quot;Determine whether the document should be publicly visible&quot;
8151 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8152 #
8153 # Example (Data Manipulation):
8154 #
8155 # title: &quot;Notification string&quot;
8156 # description: &quot;Create a notification string with a timestamp.&quot;
8157 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8158 #
8159 # The exact variables and functions that may be referenced within an expression
8160 # are determined by the service that evaluates it. See the service
8161 # documentation for additional information.
8162 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8163 # describes the expression, e.g. when hovered over it in a UI.
8164 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8165 # syntax.
8166 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8167 # reporting, e.g. a file name and a position in the file.
8168 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8169 # its purpose. This can be used e.g. in UIs which allow to enter the
8170 # expression.
8171 },
8172 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8173 # `members` can have the following values:
8174 #
8175 # * `allUsers`: A special identifier that represents anyone who is
8176 # on the internet; with or without a Google account.
8177 #
8178 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8179 # who is authenticated with a Google account or a service account.
8180 # Does not include identities that come from external identity providers
8181 # (IdPs) through identity federation.
8182 #
8183 # * `user:{emailid}`: An email address that represents a specific Google
8184 # account. For example, `[email protected]` .
8185 #
8186 #
8187 # * `serviceAccount:{emailid}`: An email address that represents a Google
8188 # service account. For example,
8189 # `[email protected]`.
8190 #
8191 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8192 # identifier for a
8193 # [Kubernetes service
8194 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8195 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8196 #
8197 # * `group:{emailid}`: An email address that represents a Google group.
8198 # For example, `[email protected]`.
8199 #
8200 #
8201 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8202 # users of that domain. For example, `google.com` or `example.com`.
8203 #
8204 #
8205 #
8206 #
8207 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8208 # A single identity in a workforce identity pool.
8209 #
8210 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8211 # All workforce identities in a group.
8212 #
8213 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8214 # All workforce identities with a specific attribute value.
8215 #
8216 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8217 # All identities in a workforce identity pool.
8218 #
8219 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8220 # A single identity in a workload identity pool.
8221 #
8222 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8223 # A workload identity pool group.
8224 #
8225 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8226 # All identities in a workload identity pool with a certain attribute.
8227 #
8228 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8229 # All identities in a workload identity pool.
8230 #
8231 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8232 # identifier) representing a user that has been recently deleted. For
8233 # example, `[email protected]?uid=123456789012345678901`. If the user is
8234 # recovered, this value reverts to `user:{emailid}` and the recovered user
8235 # retains the role in the binding.
8236 #
8237 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8238 # unique identifier) representing a service account that has been recently
8239 # deleted. For example,
8240 # `[email protected]?uid=123456789012345678901`.
8241 # If the service account is undeleted, this value reverts to
8242 # `serviceAccount:{emailid}` and the undeleted service account retains the
8243 # role in the binding.
8244 #
8245 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8246 # identifier) representing a Google group that has been recently
8247 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8248 # the group is recovered, this value reverts to `group:{emailid}` and the
8249 # recovered group retains the role in the binding.
8250 #
8251 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8252 # Deleted single identity in a workforce identity pool. For example,
8253 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8254 &quot;A String&quot;,
8255 ],
8256 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8257 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8258 #
8259 # For an overview of the IAM roles and permissions, see the
8260 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8261 # a list of the available pre-defined roles, see
8262 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8263 },
8264 ],
8265 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
8266 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
8267 &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
8268 # the policy is limited to a few 10s of KB. An empty policy is in general a
8269 # valid policy but certain services (like Projects) might reject them.
8270 # controls for Google Cloud resources.
8271 #
8272 #
8273 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8274 # `members`, or principals, to a single `role`. Principals can be user
8275 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8276 # `role` is a named list of permissions; each `role` can be an IAM predefined
8277 # role or a user-created custom role.
8278 #
8279 # For some types of Google Cloud resources, a `binding` can also specify a
8280 # `condition`, which is a logical expression that allows access to a resource
8281 # only if the expression evaluates to `true`. A condition can add constraints
8282 # based on attributes of the request, the resource, or both. To learn which
8283 # resources support conditions in their IAM policies, see the
8284 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8285 #
8286 # **JSON example:**
8287 #
8288 # ```
8289 # {
8290 # &quot;bindings&quot;: [
8291 # {
8292 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8293 # &quot;members&quot;: [
8294 # &quot;user:[email protected]&quot;,
8295 # &quot;group:[email protected]&quot;,
8296 # &quot;domain:google.com&quot;,
8297 # &quot;serviceAccount:[email protected]&quot;
8298 # ]
8299 # },
8300 # {
8301 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8302 # &quot;members&quot;: [
8303 # &quot;user:[email protected]&quot;
8304 # ],
8305 # &quot;condition&quot;: {
8306 # &quot;title&quot;: &quot;expirable access&quot;,
8307 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8308 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8309 # }
8310 # }
8311 # ],
8312 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8313 # &quot;version&quot;: 3
8314 # }
8315 # ```
8316 #
8317 # **YAML example:**
8318 #
8319 # ```
8320 # bindings:
8321 # - members:
8322 # - user:[email protected]
8323 # - group:[email protected]
8324 # - domain:google.com
8325 # - serviceAccount:[email protected]
8326 # role: roles/resourcemanager.organizationAdmin
8327 # - members:
8328 # - user:[email protected]
8329 # role: roles/resourcemanager.organizationViewer
8330 # condition:
8331 # title: expirable access
8332 # description: Does not grant access after Sep 2020
8333 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8334 # etag: BwWWja0YfJA=
8335 # version: 3
8336 # ```
8337 #
8338 # For a description of IAM and its features, see the
8339 # [IAM documentation](https://cloud.google.com/iam/docs/).
8340 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8341 { # Specifies the audit configuration for a service.
8342 # The configuration determines which permission types are logged, and what
8343 # identities, if any, are exempted from logging.
8344 # An AuditConfig must have one or more AuditLogConfigs.
8345 #
8346 # If there are AuditConfigs for both `allServices` and a specific service,
8347 # the union of the two AuditConfigs is used for that service: the log_types
8348 # specified in each AuditConfig are enabled, and the exempted_members in each
8349 # AuditLogConfig are exempted.
8350 #
8351 # Example Policy with multiple AuditConfigs:
8352 #
8353 # {
8354 # &quot;audit_configs&quot;: [
8355 # {
8356 # &quot;service&quot;: &quot;allServices&quot;,
8357 # &quot;audit_log_configs&quot;: [
8358 # {
8359 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8360 # &quot;exempted_members&quot;: [
8361 # &quot;user:[email protected]&quot;
8362 # ]
8363 # },
8364 # {
8365 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8366 # },
8367 # {
8368 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8369 # }
8370 # ]
8371 # },
8372 # {
8373 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8374 # &quot;audit_log_configs&quot;: [
8375 # {
8376 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8377 # },
8378 # {
8379 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8380 # &quot;exempted_members&quot;: [
8381 # &quot;user:[email protected]&quot;
8382 # ]
8383 # }
8384 # ]
8385 # }
8386 # ]
8387 # }
8388 #
8389 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8390 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8391 # `[email protected]` from DATA_WRITE logging.
8392 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8393 { # Provides the configuration for logging a type of permissions.
8394 # Example:
8395 #
8396 # {
8397 # &quot;audit_log_configs&quot;: [
8398 # {
8399 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8400 # &quot;exempted_members&quot;: [
8401 # &quot;user:[email protected]&quot;
8402 # ]
8403 # },
8404 # {
8405 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8406 # }
8407 # ]
8408 # }
8409 #
8410 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8411 # [email protected] from DATA_READ logging.
8412 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8413 # permission.
8414 # Follows the same format of Binding.members.
8415 &quot;A String&quot;,
8416 ],
8417 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8418 },
8419 ],
8420 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8421 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8422 # `allServices` is a special value that covers all services.
8423 },
8424 ],
8425 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8426 # may specify a `condition` that determines how and when the `bindings` are
8427 # applied. Each of the `bindings` must contain at least one principal.
8428 #
8429 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8430 # of these principals can be Google groups. Each occurrence of a principal
8431 # counts towards these limits. For example, if the `bindings` grant 50
8432 # different roles to `user:[email protected]`, and not to any other
8433 # principal, then you can add another 1,450 principals to the `bindings` in
8434 # the `Policy`.
8435 { # Associates `members`, or principals, with a `role`.
8436 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8437 #
8438 # If the condition evaluates to `true`, then this binding applies to the
8439 # current request.
8440 #
8441 # If the condition evaluates to `false`, then this binding does not apply to
8442 # the current request. However, a different role binding might grant the same
8443 # role to one or more of the principals in this binding.
8444 #
8445 # To learn which resources support conditions in their IAM policies, see the
8446 # [IAM
8447 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8448 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8449 # are documented at https://github.com/google/cel-spec.
8450 #
8451 # Example (Comparison):
8452 #
8453 # title: &quot;Summary size limit&quot;
8454 # description: &quot;Determines if a summary is less than 100 chars&quot;
8455 # expression: &quot;document.summary.size() &lt; 100&quot;
8456 #
8457 # Example (Equality):
8458 #
8459 # title: &quot;Requestor is owner&quot;
8460 # description: &quot;Determines if requestor is the document owner&quot;
8461 # expression: &quot;document.owner == request.auth.claims.email&quot;
8462 #
8463 # Example (Logic):
8464 #
8465 # title: &quot;Public documents&quot;
8466 # description: &quot;Determine whether the document should be publicly visible&quot;
8467 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8468 #
8469 # Example (Data Manipulation):
8470 #
8471 # title: &quot;Notification string&quot;
8472 # description: &quot;Create a notification string with a timestamp.&quot;
8473 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8474 #
8475 # The exact variables and functions that may be referenced within an expression
8476 # are determined by the service that evaluates it. See the service
8477 # documentation for additional information.
8478 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8479 # describes the expression, e.g. when hovered over it in a UI.
8480 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8481 # syntax.
8482 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8483 # reporting, e.g. a file name and a position in the file.
8484 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8485 # its purpose. This can be used e.g. in UIs which allow to enter the
8486 # expression.
8487 },
8488 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8489 # `members` can have the following values:
8490 #
8491 # * `allUsers`: A special identifier that represents anyone who is
8492 # on the internet; with or without a Google account.
8493 #
8494 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8495 # who is authenticated with a Google account or a service account.
8496 # Does not include identities that come from external identity providers
8497 # (IdPs) through identity federation.
8498 #
8499 # * `user:{emailid}`: An email address that represents a specific Google
8500 # account. For example, `[email protected]` .
8501 #
8502 #
8503 # * `serviceAccount:{emailid}`: An email address that represents a Google
8504 # service account. For example,
8505 # `[email protected]`.
8506 #
8507 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8508 # identifier for a
8509 # [Kubernetes service
8510 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8511 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8512 #
8513 # * `group:{emailid}`: An email address that represents a Google group.
8514 # For example, `[email protected]`.
8515 #
8516 #
8517 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8518 # users of that domain. For example, `google.com` or `example.com`.
8519 #
8520 #
8521 #
8522 #
8523 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8524 # A single identity in a workforce identity pool.
8525 #
8526 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8527 # All workforce identities in a group.
8528 #
8529 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8530 # All workforce identities with a specific attribute value.
8531 #
8532 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8533 # All identities in a workforce identity pool.
8534 #
8535 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8536 # A single identity in a workload identity pool.
8537 #
8538 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8539 # A workload identity pool group.
8540 #
8541 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8542 # All identities in a workload identity pool with a certain attribute.
8543 #
8544 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8545 # All identities in a workload identity pool.
8546 #
8547 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8548 # identifier) representing a user that has been recently deleted. For
8549 # example, `[email protected]?uid=123456789012345678901`. If the user is
8550 # recovered, this value reverts to `user:{emailid}` and the recovered user
8551 # retains the role in the binding.
8552 #
8553 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8554 # unique identifier) representing a service account that has been recently
8555 # deleted. For example,
8556 # `[email protected]?uid=123456789012345678901`.
8557 # If the service account is undeleted, this value reverts to
8558 # `serviceAccount:{emailid}` and the undeleted service account retains the
8559 # role in the binding.
8560 #
8561 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8562 # identifier) representing a Google group that has been recently
8563 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8564 # the group is recovered, this value reverts to `group:{emailid}` and the
8565 # recovered group retains the role in the binding.
8566 #
8567 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8568 # Deleted single identity in a workforce identity pool. For example,
8569 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8570 &quot;A String&quot;,
8571 ],
8572 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8573 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8574 #
8575 # For an overview of the IAM roles and permissions, see the
8576 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8577 # a list of the available pre-defined roles, see
8578 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8579 },
8580 ],
8581 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8582 # prevent simultaneous updates of a policy from overwriting each other.
8583 # It is strongly suggested that systems make use of the `etag` in the
8584 # read-modify-write cycle to perform policy updates in order to avoid race
8585 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8586 # systems are expected to put that etag in the request to `setIamPolicy` to
8587 # ensure that their change will be applied to the same version of the policy.
8588 #
8589 # **Important:** If you use IAM Conditions, you must include the `etag` field
8590 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8591 # you to overwrite a version `3` policy with a version `1` policy, and all of
8592 # the conditions in the version `3` policy are lost.
8593 &quot;version&quot;: 42, # Specifies the format of the policy.
8594 #
8595 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8596 # are rejected.
8597 #
8598 # Any operation that affects conditional role bindings must specify version
8599 # `3`. This requirement applies to the following operations:
8600 #
8601 # * Getting a policy that includes a conditional role binding
8602 # * Adding a conditional role binding to a policy
8603 # * Changing a conditional role binding in a policy
8604 # * Removing any role binding, with or without a condition, from a policy
8605 # that includes conditions
8606 #
8607 # **Important:** If you use IAM Conditions, you must include the `etag` field
8608 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8609 # you to overwrite a version `3` policy with a version `1` policy, and all of
8610 # the conditions in the version `3` policy are lost.
8611 #
8612 # If a policy does not include any conditions, operations on that policy may
8613 # specify any valid version or leave the field unset.
8614 #
8615 # To learn which resources support conditions in their IAM policies, see the
8616 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8617 },
8618 }
8619
8620 x__xgafv: string, V1 error format.
8621 Allowed values
8622 1 - v1 error format
8623 2 - v2 error format
8624
8625 Returns:
8626 An object of the form:
8627
8628 { # An Identity and Access Management (IAM) policy, which specifies access
8629 # controls for Google Cloud resources.
8630 #
8631 #
8632 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8633 # `members`, or principals, to a single `role`. Principals can be user
8634 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8635 # `role` is a named list of permissions; each `role` can be an IAM predefined
8636 # role or a user-created custom role.
8637 #
8638 # For some types of Google Cloud resources, a `binding` can also specify a
8639 # `condition`, which is a logical expression that allows access to a resource
8640 # only if the expression evaluates to `true`. A condition can add constraints
8641 # based on attributes of the request, the resource, or both. To learn which
8642 # resources support conditions in their IAM policies, see the
8643 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8644 #
8645 # **JSON example:**
8646 #
8647 # ```
8648 # {
8649 # &quot;bindings&quot;: [
8650 # {
8651 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8652 # &quot;members&quot;: [
8653 # &quot;user:[email protected]&quot;,
8654 # &quot;group:[email protected]&quot;,
8655 # &quot;domain:google.com&quot;,
8656 # &quot;serviceAccount:[email protected]&quot;
8657 # ]
8658 # },
8659 # {
8660 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8661 # &quot;members&quot;: [
8662 # &quot;user:[email protected]&quot;
8663 # ],
8664 # &quot;condition&quot;: {
8665 # &quot;title&quot;: &quot;expirable access&quot;,
8666 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8667 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8668 # }
8669 # }
8670 # ],
8671 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8672 # &quot;version&quot;: 3
8673 # }
8674 # ```
8675 #
8676 # **YAML example:**
8677 #
8678 # ```
8679 # bindings:
8680 # - members:
8681 # - user:[email protected]
8682 # - group:[email protected]
8683 # - domain:google.com
8684 # - serviceAccount:[email protected]
8685 # role: roles/resourcemanager.organizationAdmin
8686 # - members:
8687 # - user:[email protected]
8688 # role: roles/resourcemanager.organizationViewer
8689 # condition:
8690 # title: expirable access
8691 # description: Does not grant access after Sep 2020
8692 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8693 # etag: BwWWja0YfJA=
8694 # version: 3
8695 # ```
8696 #
8697 # For a description of IAM and its features, see the
8698 # [IAM documentation](https://cloud.google.com/iam/docs/).
8699 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8700 { # Specifies the audit configuration for a service.
8701 # The configuration determines which permission types are logged, and what
8702 # identities, if any, are exempted from logging.
8703 # An AuditConfig must have one or more AuditLogConfigs.
8704 #
8705 # If there are AuditConfigs for both `allServices` and a specific service,
8706 # the union of the two AuditConfigs is used for that service: the log_types
8707 # specified in each AuditConfig are enabled, and the exempted_members in each
8708 # AuditLogConfig are exempted.
8709 #
8710 # Example Policy with multiple AuditConfigs:
8711 #
8712 # {
8713 # &quot;audit_configs&quot;: [
8714 # {
8715 # &quot;service&quot;: &quot;allServices&quot;,
8716 # &quot;audit_log_configs&quot;: [
8717 # {
8718 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8719 # &quot;exempted_members&quot;: [
8720 # &quot;user:[email protected]&quot;
8721 # ]
8722 # },
8723 # {
8724 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8725 # },
8726 # {
8727 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8728 # }
8729 # ]
8730 # },
8731 # {
8732 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8733 # &quot;audit_log_configs&quot;: [
8734 # {
8735 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8736 # },
8737 # {
8738 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8739 # &quot;exempted_members&quot;: [
8740 # &quot;user:[email protected]&quot;
8741 # ]
8742 # }
8743 # ]
8744 # }
8745 # ]
8746 # }
8747 #
8748 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8749 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8750 # `[email protected]` from DATA_WRITE logging.
8751 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8752 { # Provides the configuration for logging a type of permissions.
8753 # Example:
8754 #
8755 # {
8756 # &quot;audit_log_configs&quot;: [
8757 # {
8758 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8759 # &quot;exempted_members&quot;: [
8760 # &quot;user:[email protected]&quot;
8761 # ]
8762 # },
8763 # {
8764 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8765 # }
8766 # ]
8767 # }
8768 #
8769 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8770 # [email protected] from DATA_READ logging.
8771 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8772 # permission.
8773 # Follows the same format of Binding.members.
8774 &quot;A String&quot;,
8775 ],
8776 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8777 },
8778 ],
8779 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8780 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8781 # `allServices` is a special value that covers all services.
8782 },
8783 ],
8784 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8785 # may specify a `condition` that determines how and when the `bindings` are
8786 # applied. Each of the `bindings` must contain at least one principal.
8787 #
8788 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8789 # of these principals can be Google groups. Each occurrence of a principal
8790 # counts towards these limits. For example, if the `bindings` grant 50
8791 # different roles to `user:[email protected]`, and not to any other
8792 # principal, then you can add another 1,450 principals to the `bindings` in
8793 # the `Policy`.
8794 { # Associates `members`, or principals, with a `role`.
8795 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8796 #
8797 # If the condition evaluates to `true`, then this binding applies to the
8798 # current request.
8799 #
8800 # If the condition evaluates to `false`, then this binding does not apply to
8801 # the current request. However, a different role binding might grant the same
8802 # role to one or more of the principals in this binding.
8803 #
8804 # To learn which resources support conditions in their IAM policies, see the
8805 # [IAM
8806 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8807 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8808 # are documented at https://github.com/google/cel-spec.
8809 #
8810 # Example (Comparison):
8811 #
8812 # title: &quot;Summary size limit&quot;
8813 # description: &quot;Determines if a summary is less than 100 chars&quot;
8814 # expression: &quot;document.summary.size() &lt; 100&quot;
8815 #
8816 # Example (Equality):
8817 #
8818 # title: &quot;Requestor is owner&quot;
8819 # description: &quot;Determines if requestor is the document owner&quot;
8820 # expression: &quot;document.owner == request.auth.claims.email&quot;
8821 #
8822 # Example (Logic):
8823 #
8824 # title: &quot;Public documents&quot;
8825 # description: &quot;Determine whether the document should be publicly visible&quot;
8826 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8827 #
8828 # Example (Data Manipulation):
8829 #
8830 # title: &quot;Notification string&quot;
8831 # description: &quot;Create a notification string with a timestamp.&quot;
8832 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8833 #
8834 # The exact variables and functions that may be referenced within an expression
8835 # are determined by the service that evaluates it. See the service
8836 # documentation for additional information.
8837 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8838 # describes the expression, e.g. when hovered over it in a UI.
8839 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8840 # syntax.
8841 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8842 # reporting, e.g. a file name and a position in the file.
8843 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8844 # its purpose. This can be used e.g. in UIs which allow to enter the
8845 # expression.
8846 },
8847 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8848 # `members` can have the following values:
8849 #
8850 # * `allUsers`: A special identifier that represents anyone who is
8851 # on the internet; with or without a Google account.
8852 #
8853 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8854 # who is authenticated with a Google account or a service account.
8855 # Does not include identities that come from external identity providers
8856 # (IdPs) through identity federation.
8857 #
8858 # * `user:{emailid}`: An email address that represents a specific Google
8859 # account. For example, `[email protected]` .
8860 #
8861 #
8862 # * `serviceAccount:{emailid}`: An email address that represents a Google
8863 # service account. For example,
8864 # `[email protected]`.
8865 #
8866 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8867 # identifier for a
8868 # [Kubernetes service
8869 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8870 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8871 #
8872 # * `group:{emailid}`: An email address that represents a Google group.
8873 # For example, `[email protected]`.
8874 #
8875 #
8876 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8877 # users of that domain. For example, `google.com` or `example.com`.
8878 #
8879 #
8880 #
8881 #
8882 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8883 # A single identity in a workforce identity pool.
8884 #
8885 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8886 # All workforce identities in a group.
8887 #
8888 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8889 # All workforce identities with a specific attribute value.
8890 #
8891 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8892 # All identities in a workforce identity pool.
8893 #
8894 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8895 # A single identity in a workload identity pool.
8896 #
8897 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8898 # A workload identity pool group.
8899 #
8900 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8901 # All identities in a workload identity pool with a certain attribute.
8902 #
8903 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8904 # All identities in a workload identity pool.
8905 #
8906 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8907 # identifier) representing a user that has been recently deleted. For
8908 # example, `[email protected]?uid=123456789012345678901`. If the user is
8909 # recovered, this value reverts to `user:{emailid}` and the recovered user
8910 # retains the role in the binding.
8911 #
8912 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8913 # unique identifier) representing a service account that has been recently
8914 # deleted. For example,
8915 # `[email protected]?uid=123456789012345678901`.
8916 # If the service account is undeleted, this value reverts to
8917 # `serviceAccount:{emailid}` and the undeleted service account retains the
8918 # role in the binding.
8919 #
8920 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8921 # identifier) representing a Google group that has been recently
8922 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8923 # the group is recovered, this value reverts to `group:{emailid}` and the
8924 # recovered group retains the role in the binding.
8925 #
8926 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8927 # Deleted single identity in a workforce identity pool. For example,
8928 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8929 &quot;A String&quot;,
8930 ],
8931 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8932 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8933 #
8934 # For an overview of the IAM roles and permissions, see the
8935 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8936 # a list of the available pre-defined roles, see
8937 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8938 },
8939 ],
8940 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8941 # prevent simultaneous updates of a policy from overwriting each other.
8942 # It is strongly suggested that systems make use of the `etag` in the
8943 # read-modify-write cycle to perform policy updates in order to avoid race
8944 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8945 # systems are expected to put that etag in the request to `setIamPolicy` to
8946 # ensure that their change will be applied to the same version of the policy.
8947 #
8948 # **Important:** If you use IAM Conditions, you must include the `etag` field
8949 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8950 # you to overwrite a version `3` policy with a version `1` policy, and all of
8951 # the conditions in the version `3` policy are lost.
8952 &quot;version&quot;: 42, # Specifies the format of the policy.
8953 #
8954 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8955 # are rejected.
8956 #
8957 # Any operation that affects conditional role bindings must specify version
8958 # `3`. This requirement applies to the following operations:
8959 #
8960 # * Getting a policy that includes a conditional role binding
8961 # * Adding a conditional role binding to a policy
8962 # * Changing a conditional role binding in a policy
8963 # * Removing any role binding, with or without a condition, from a policy
8964 # that includes conditions
8965 #
8966 # **Important:** If you use IAM Conditions, you must include the `etag` field
8967 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8968 # you to overwrite a version `3` policy with a version `1` policy, and all of
8969 # the conditions in the version `3` policy are lost.
8970 #
8971 # If a policy does not include any conditions, operations on that policy may
8972 # specify any valid version or leave the field unset.
8973 #
8974 # To learn which resources support conditions in their IAM policies, see the
8975 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8976 }</pre>
8977 </div>
8978
8979 <div class="method">
8980 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
8981 <pre>Sets the Google Cloud Armor security policy for the specified backend
8982 service. For more information, seeGoogle
8983 Cloud Armor Overview
8984
8985 Args:
8986 project: string, Project ID for this request. (required)
8987 region: string, Name of the region scoping this request. (required)
8988 backendService: string, Name of the BackendService resource to which the security policy should be
8989 set. The name should conform to RFC1035. (required)
8990 body: object, The request body.
8991 The object takes the form of:
8992
8993 {
8994 &quot;securityPolicy&quot;: &quot;A String&quot;,
8995 }
8996
8997 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8998 that if you must retry your request, the server will know to ignore the
8999 request if it has already been completed.
9000
9001 For example, consider a situation where you make an initial request and
9002 the request times out. If you make the request again with the same
9003 request ID, the server can check if original operation with the same
9004 request ID was received, and if so, will ignore the second request. This
9005 prevents clients from accidentally creating duplicate commitments.
9006
9007 The request ID must be
9008 a valid UUID with the exception that zero UUID is not supported
9009 (00000000-0000-0000-0000-000000000000).
9010 x__xgafv: string, V1 error format.
9011 Allowed values
9012 1 - v1 error format
9013 2 - v2 error format
9014
9015 Returns:
9016 An object of the form:
9017
9018 { # Represents an Operation resource.
9019 #
9020 # Google Compute Engine has three Operation resources:
9021 #
9022 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9023 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9024 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9025 #
9026 # You can use an operation resource to manage asynchronous API requests.
9027 # For more information, readHandling
9028 # API responses.
9029 #
9030 # Operations can be global, regional or zonal.
9031 #
9032 # - For global operations, use the `globalOperations`
9033 # resource.
9034 # - For regional operations, use the
9035 # `regionOperations` resource.
9036 # - For zonal operations, use
9037 # the `zoneOperations` resource.
9038 #
9039 #
9040 #
9041 # For more information, read
9042 # Global, Regional, and Zonal Resources.
9043 #
9044 # Note that completed Operation resources have a limited
9045 # retention period.
9046 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9047 # Not present otherwise.
9048 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9049 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9050 # set when the operation is created.
9051 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9052 # text format.
9053 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9054 # this field will be populated.
9055 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9056 # operation.
9057 {
9058 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9059 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9060 # details. There is a set of defined message types to use for providing
9061 # details.The syntax depends on the error code. For example,
9062 # QuotaExceededInfo will have details when the error code is
9063 # QUOTA_EXCEEDED.
9064 {
9065 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9066 #
9067 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9068 # is not enabled:
9069 #
9070 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9071 # &quot;domain&quot;: &quot;googleapis.com&quot;
9072 # &quot;metadata&quot;: {
9073 # &quot;resource&quot;: &quot;projects/123&quot;,
9074 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9075 # }
9076 # }
9077 #
9078 # This response indicates that the pubsub.googleapis.com API is not enabled.
9079 #
9080 # Example of an error that is returned when attempting to create a Spanner
9081 # instance in a region that is out of stock:
9082 #
9083 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9084 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9085 # &quot;metadata&quot;: {
9086 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9087 # }
9088 # }
9089 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9090 # is typically the registered service name of the tool or product that
9091 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9092 # generated by some common infrastructure, the error domain must be a
9093 # globally unique value that identifies the infrastructure. For Google API
9094 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9095 &quot;metadatas&quot;: { # Additional structured details about this error.
9096 #
9097 # Keys must match a regular expression of `a-z+` but should
9098 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9099 # length. When identifying the current value of an exceeded limit, the units
9100 # should be contained in the key, not the value. For example, rather than
9101 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9102 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9103 # instances that can be created in a single (batch) request.
9104 &quot;a_key&quot;: &quot;A String&quot;,
9105 },
9106 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9107 # proximate cause of the error. Error reasons are unique within a particular
9108 # domain of errors. This should be at most 63 characters and match a
9109 # regular expression of `A-Z+[A-Z0-9]`, which represents
9110 # UPPER_SNAKE_CASE.
9111 },
9112 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9113 #
9114 # For example, if a quota check failed with an error indicating the calling
9115 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9116 # directly to the right place in the developer console to flip the bit.
9117 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9118 { # Describes a URL link.
9119 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9120 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9121 },
9122 ],
9123 },
9124 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9125 # which can be attached to an RPC error.
9126 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9127 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9128 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9129 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9130 },
9131 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9132 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9133 &quot;a_key&quot;: &quot;A String&quot;,
9134 },
9135 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9136 # type or metric.
9137 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9138 # or metric.
9139 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9140 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9141 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9142 },
9143 },
9144 ],
9145 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9146 # This property is optional.
9147 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9148 },
9149 ],
9150 },
9151 &quot;getVersionOperationMetadata&quot;: {
9152 &quot;inlineSbomInfo&quot;: {
9153 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9154 # appropriate identifiers.
9155 &quot;a_key&quot;: &quot;A String&quot;,
9156 },
9157 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9158 # identifiers.
9159 &quot;a_key&quot;: &quot;A String&quot;,
9160 },
9161 },
9162 },
9163 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9164 # message that was returned, such as `NOT FOUND`.
9165 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9166 # status code that was returned. For example, a `404` means the
9167 # resource was not found.
9168 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9169 # defined by the server.
9170 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9171 # This value is inRFC3339
9172 # text format.
9173 &quot;instancesBulkInsertOperationMetadata&quot;: {
9174 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9175 # Example key: zones/us-central1-a
9176 &quot;a_key&quot;: {
9177 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9178 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9179 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9180 # error.
9181 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9182 # if the flow is rolling forward or rolling back.
9183 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9184 },
9185 },
9186 },
9187 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9188 # Operation resources.
9189 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9190 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9191 # group of operations results from a `bulkInsert` API request.
9192 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9193 # `update`, or `delete`, and so on.
9194 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9195 # There is no requirement that this be linear or support any granularity of
9196 # operations. This should not be used to guess when the operation will be
9197 # complete. This number should monotonically increase as the operation
9198 # progresses.
9199 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9200 # applicable when performing regional operations.
9201 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9202 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9203 # this field will contain information on all underlying zonal actions and
9204 # their state.
9205 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9206 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9207 # Example key: zones/us-central1-a
9208 &quot;a_key&quot;: {
9209 &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
9210 # populated.
9211 # different programming environments, including REST APIs and RPC APIs. It is
9212 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9213 # three pieces of data: error code, error message, and error details.
9214 #
9215 # You can find out more about this error model and how to work with it in the
9216 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9217 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9218 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9219 # message types for APIs to use.
9220 {
9221 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9222 },
9223 ],
9224 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9225 # user-facing error message should be localized and sent in the
9226 # google.rpc.Status.details field, or localized by the client.
9227 },
9228 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9229 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9230 },
9231 },
9232 },
9233 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9234 # This value is inRFC3339
9235 # text format.
9236 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9237 # following:
9238 # `PENDING`, `RUNNING`, or `DONE`.
9239 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9240 # operation.
9241 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9242 # of the target resource.
9243 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9244 # operations related to creating a snapshot, this points to the disk
9245 # that the snapshot was created from.
9246 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9247 # `[email protected]` or
9248 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9249 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9250 # operation, this field will be populated.
9251 {
9252 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9253 # Engine returns NO_RESULTS_ON_PAGE if there
9254 # are no results in the response.
9255 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9256 # value format. For example:
9257 #
9258 # &quot;data&quot;: [
9259 # {
9260 # &quot;key&quot;: &quot;scope&quot;,
9261 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9262 # }
9263 {
9264 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9265 # returned. For example, for warnings where there are no results in a list
9266 # request for a particular zone, this key might be scope and
9267 # the key value might be the zone name. Other examples might be a key
9268 # indicating a deprecated resource and a suggested replacement, or a
9269 # warning about invalid network settings (for example, if an instance
9270 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9271 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9272 },
9273 ],
9274 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9275 },
9276 ],
9277 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9278 # applicable when performing per-zone operations.
9279 }</pre>
9280 </div>
9281
9282 <div class="method">
9283 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
9284 <pre>Returns permissions that a caller has on the specified resource.
9285
9286 Args:
9287 project: string, Project ID for this request. (required)
9288 region: string, The name of the region for this request. (required)
9289 resource: string, Name or id of the resource for this request. (required)
9290 body: object, The request body.
9291 The object takes the form of:
9292
9293 {
9294 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
9295 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
9296 &quot;A String&quot;,
9297 ],
9298 }
9299
9300 x__xgafv: string, V1 error format.
9301 Allowed values
9302 1 - v1 error format
9303 2 - v2 error format
9304
9305 Returns:
9306 An object of the form:
9307
9308 {
9309 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
9310 # allowed.
9311 &quot;A String&quot;,
9312 ],
9313 }</pre>
9314 </div>
9315
9316 <div class="method">
9317 <code class="details" id="update">update(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
9318 <pre>Updates the specified regional BackendService resource with the data
9319 included in the request. For more information,
9320 see
9321 Backend services overview.
9322
9323 Args:
9324 project: string, Project ID for this request. (required)
9325 region: string, Name of the region scoping this request. (required)
9326 backendService: string, Name of the BackendService resource to update. (required)
9327 body: object, The request body.
9328 The object takes the form of:
9329
9330 { # Represents a Backend Service resource.
9331 #
9332 # A backend service defines how Google Cloud load balancers distribute traffic.
9333 # The backend service configuration contains a set of values, such as the
9334 # protocol used to connect to backends, various distribution and session
9335 # settings, health checks, and timeouts. These settings provide fine-grained
9336 # control over how your load balancer behaves. Most of the settings have
9337 # default values that allow for easy configuration if you need to get started
9338 # quickly.
9339 #
9340 # Backend services in Google Compute Engine can be either regionally or
9341 # globally scoped.
9342 #
9343 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
9344 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
9345 #
9346 # For more information, seeBackend
9347 # Services.
9348 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
9349 # Load Balancers and Traffic Director and requires
9350 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
9351 #
9352 # If set to 0, the cookie is non-persistent and lasts only until
9353 # the end of the browser session (or equivalent). The maximum allowed value
9354 # is two weeks (1,209,600).
9355 #
9356 # Not supported when the backend service is referenced by a URL map that is
9357 # bound to target gRPC proxy that has validateForProxyless field set to true.
9358 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
9359 { # Message containing information of one individual backend.
9360 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
9361 # handle additional traffic or is fully loaded. For usage guidelines, see
9362 # Connection balancing mode.
9363 #
9364 # Backends must use compatible balancing modes. For more information, see
9365 # Supported balancing modes and target capacity settings and
9366 # Restrictions and guidance for instance groups.
9367 #
9368 # Note: Currently, if you use the API to configure incompatible balancing
9369 # modes, the configuration might be accepted even though it has no impact
9370 # and is ignored. Specifically, Backend.maxUtilization is ignored when
9371 # Backend.balancingMode is RATE. In the future, this incompatible combination
9372 # will be rejected.
9373 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
9374 # mode.
9375 # The default value is 1, which means the group serves up to
9376 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
9377 # completely drained, offering 0% of its available capacity. The valid ranges
9378 # are 0.0 and [0.1,1.0].
9379 # You cannot configure a setting larger than 0 and smaller than0.1.
9380 # You cannot configure a setting of 0 when there is only one
9381 # backend attached to the backend service.
9382 #
9383 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
9384 # internet NEGs, regional serverless NEGs, and PSC NEGs.
9385 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
9386 # BalancingMode.
9387 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
9388 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
9389 # Monitoring, but is not used for load balancing.
9390 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
9391 # balancing mode. The valid range is [0.0, 1.0].
9392 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
9393 # long and match the regular expression
9394 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
9395 # first character must be a lowercase letter, and all following
9396 # characters must be a dash, period, underscore, lowercase letter, or
9397 # digit, except the last character, which cannot be a dash, period, or
9398 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
9399 # field can only be used for a global or regional backend service with the
9400 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
9401 },
9402 ],
9403 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9404 # create the resource.
9405 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
9406 # failover backend can be configured for a given BackendService.
9407 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
9408 # group or network endpoint
9409 # group (NEG) resource. To determine what types of backends a load
9410 # balancer supports, see the [Backend services
9411 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
9412 #
9413 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
9414 # or NEG. Partial URLs are not supported.
9415 #
9416 # If haPolicy is specified, backends must refer to NEG resources of type
9417 # GCE_VM_IP.
9418 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
9419 # guidelines, seeConnection
9420 # balancing mode and Utilization
9421 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
9422 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
9423 # guidelines, seeConnection
9424 # balancing mode and Utilization
9425 # balancing mode.
9426 #
9427 # Not available if the backend&#x27;s balancingMode isRATE.
9428 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
9429 # For usage guidelines, seeConnection
9430 # balancing mode and Utilization
9431 # balancing mode.
9432 #
9433 # Not available if the backend&#x27;s balancingMode isRATE.
9434 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
9435 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
9436 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
9437 # Not available if backend&#x27;s balancingMode is RATE
9438 # or CONNECTION.
9439 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
9440 # Not available if backend&#x27;s balancingMode is RATE
9441 # or CONNECTION.
9442 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
9443 # usage guidelines, seeRate
9444 # balancing mode and Utilization
9445 # balancing mode.
9446 #
9447 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9448 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
9449 # guidelines, seeRate
9450 # balancing mode and Utilization
9451 # balancing mode.
9452 #
9453 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9454 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
9455 # guidelines, seeRate
9456 # balancing mode and Utilization
9457 # balancing mode.
9458 #
9459 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9460 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
9461 #
9462 # For usage guidelines, seeUtilization
9463 # balancing mode.
9464 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
9465 # the backend.
9466 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
9467 },
9468 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
9469 # sending traffic to backends with default preference. The possible values
9470 # are:
9471 #
9472 # - PREFERRED: Backends with this preference level will be
9473 # filled up to their capacity limits first, based on RTT.
9474 # - DEFAULT: If preferred backends don&#x27;t have enough
9475 # capacity, backends in this layer would be used and traffic would be
9476 # assigned based on the load balancing algorithm you use. This is the
9477 # default
9478 &quot;trafficDuration&quot;: &quot;A String&quot;,
9479 },
9480 ],
9481 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
9482 # specified load balancer types.
9483 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
9484 # Pragma or Authorization headers. Up to 5 headers can be specified.
9485 # The cache is bypassed for all cdnPolicy.cacheMode settings.
9486 { # Bypass the cache when the specified request headers are present,
9487 # e.g. Pragma or Authorization headers. Values are case insensitive.
9488 # The presence of such a header overrides the cache_mode setting.
9489 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
9490 # Values are case-insensitive.
9491 },
9492 ],
9493 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
9494 # CDN.
9495 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
9496 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
9497 &quot;A String&quot;,
9498 ],
9499 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
9500 # The name=value pair will be used in the cache key Cloud CDN generates.
9501 &quot;A String&quot;,
9502 ],
9503 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
9504 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
9505 # query_string_whitelist and query_string_blacklist. If neither is set, the
9506 # entire query string will be included. If false, the query string will be
9507 # excluded from the cache key entirely.
9508 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
9509 # parameters will be included. Either specify query_string_whitelist or
9510 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
9511 # not treated as delimiters.
9512 &quot;A String&quot;,
9513 ],
9514 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
9515 # parameters will be excluded. Either specify query_string_whitelist or
9516 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
9517 # not treated as delimiters.
9518 &quot;A String&quot;,
9519 ],
9520 },
9521 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
9522 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
9523 # headers to cache content. Responses without these headers will not be
9524 # cached at Google&#x27;s edge, and will require a full trip to the origin on
9525 # every request, potentially impacting performance and increasing load on
9526 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
9527 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
9528 # Warning: this may result in Cloud CDN caching private,
9529 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
9530 # including common image formats, media (video and audio), and web assets
9531 # (JavaScript and CSS). Requests and responses that are marked as
9532 # uncacheable, as well as dynamic content (including HTML), will not be
9533 # cached.
9534 #
9535 # If no value is provided for cdnPolicy.cacheMode, it defaults
9536 # to CACHE_ALL_STATIC.
9537 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
9538 # used to clamp the max-age (or Expires) value sent to the client. With
9539 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
9540 # response max-age directive, along with a &quot;public&quot; directive. For
9541 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
9542 # from the origin (if specified), or else sets the response max-age
9543 # directive to the lesser of the client_ttl and default_ttl, and also
9544 # ensures a &quot;public&quot; cache-control directive is present.
9545 # If a client TTL is not specified, a default value (1 hour) will be used.
9546 # The maximum allowed value is 31,622,400s (1 year).
9547 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
9548 # responses that do not have an existing valid TTL (max-age or s-maxage).
9549 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
9550 # The value of defaultTTL cannot be set to a value greater than that of
9551 # maxTTL, but can be equal.
9552 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
9553 # will overwrite the TTL set in all responses. The maximum allowed value is
9554 # 31,622,400s (1 year), noting that infrequently accessed objects may be
9555 # evicted from the cache before the defined TTL.
9556 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
9557 # origin.
9558 # Cache directives that attempt to set a max-age or s-maxage higher than
9559 # this, or an Expires header more than maxTTL seconds in the future will
9560 # be capped at the value of maxTTL, as if it were the value of an
9561 # s-maxage Cache-Control directive.
9562 # Headers sent to the client will not be modified.
9563 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
9564 # The maximum allowed value is 31,622,400s (1 year), noting that
9565 # infrequently accessed objects may be evicted from the cache before
9566 # the defined TTL.
9567 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
9568 # to apply fine-grained caching for common errors or redirects.
9569 # This can reduce the load on your origin and improve end-user
9570 # experience by reducing response latency.
9571 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
9572 # negative caching applies to responses with the specified response code
9573 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
9574 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
9575 # to all responses with the specified response code, and override any
9576 # caching headers.
9577 # By default, Cloud CDN will apply the following default TTLs to these
9578 # status codes:
9579 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
9580 # HTTP 404 (Not Found), 410 (Gone),
9581 # 451 (Unavailable For Legal Reasons): 120s
9582 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
9583 # These defaults can be overridden in negative_caching_policy.
9584 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
9585 # negative_caching must be enabled to configure negative_caching_policy.
9586 # Omitting the policy and leaving negative_caching enabled will use
9587 # Cloud CDN&#x27;s default cache TTLs.
9588 # Note that when specifying an explicit negative_caching_policy, you
9589 # should take care to specify a cache TTL for all response codes
9590 # that you wish to cache. Cloud CDN will not apply any default
9591 # negative caching when a policy exists.
9592 { # Specify CDN TTLs for response error codes.
9593 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
9594 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
9595 # specified as values, and you cannot specify a status code more than
9596 # once.
9597 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
9598 # corresponding status code.
9599 # The maximum allowed value is 1800s (30 minutes), noting that
9600 # infrequently accessed objects may be evicted from the cache before the
9601 # defined TTL.
9602 },
9603 ],
9604 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
9605 # requests into a small number of requests to the origin.
9606 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
9607 # content with the origin, or when an error is encountered when refreshing
9608 # the cache.
9609 # This setting defines the default &quot;max-stale&quot; duration for any cached
9610 # responses that do not specify a max-stale directive. Stale responses that
9611 # exceed the TTL configured here will not be served. The default limit
9612 # (max-stale) is 86400s (1 day), which will allow stale content to be
9613 # served up to this limit beyond the max-age (or s-maxage) of a cached
9614 # response.
9615 # The maximum allowed value is 604800 (1 week).
9616 # Set this to zero (0) to disable serve-while-stale.
9617 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
9618 # considered fresh. After this time period, the response will be
9619 # revalidated before being served. Defaults to 1hr (3600s). When serving
9620 # responses to signed URL requests, Cloud CDN will internally behave as
9621 # though all responses from this backend had a &quot;Cache-Control:
9622 # public, max-age=[TTL]&quot; header, regardless of any existing
9623 # Cache-Control header. The actual headers served in responses will not be
9624 # altered.
9625 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
9626 &quot;A String&quot;,
9627 ],
9628 },
9629 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
9630 # backend service.
9631 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
9632 # there is no limit.
9633 #
9634 # Not supported when the backend service is referenced by a URL map that is
9635 # bound to target gRPC proxy that has validateForProxyless field set to true.
9636 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
9637 # not specified, there is no limit.
9638 #
9639 # Not supported when the backend service is referenced by a URL map that is
9640 # bound to target gRPC proxy that has validateForProxyless field set to true.
9641 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
9642 # service. If not specified, there is no limit.
9643 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
9644 # This parameter is respected by both the HTTP/1.1 and HTTP/2
9645 # implementations. If not specified, there is no limit. Setting this
9646 # parameter to 1 will effectively disable keep alive.
9647 #
9648 # Not supported when the backend service is referenced by a URL map that is
9649 # bound to target gRPC proxy that has validateForProxyless field set to true.
9650 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
9651 # not specified, the default is 1.
9652 #
9653 # Not supported when the backend service is referenced by a URL map that is
9654 # bound to target gRPC proxy that has validateForProxyless field set to true.
9655 },
9656 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
9657 # the client&#x27;s Accept-Encoding header.
9658 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
9659 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
9660 # instance. For supported load balancers and protocols, as described inEnabling
9661 # connection draining.
9662 },
9663 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
9664 # tracking policy settings are only available for external passthrough
9665 # Network Load Balancers and internal passthrough Network Load Balancers.
9666 #
9667 # connectionTrackingPolicy cannot be specified with haPolicy.
9668 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
9669 # value is DEFAULT_FOR_PROTOCOL.
9670 #
9671 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
9672 # persist on unhealthy backends only for connection-oriented protocols
9673 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
9674 # Affinity is configured for 5-tuple. They do not persist forUDP.
9675 #
9676 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
9677 # the existing connections on the unhealthy backend are never persisted on
9678 # the unhealthy backend. They are always diverted to newly selected healthy
9679 # backends (unless all backends are unhealthy).
9680 #
9681 # If set to ALWAYS_PERSIST, existing connections always
9682 # persist on unhealthy backends regardless of protocol and session
9683 # affinity. It is generally not recommended to use this mode overriding the
9684 # default.
9685 #
9686 # For more details, see [Connection Persistence for Network Load
9687 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
9688 # and [Connection Persistence for Internal TCP/UDP Load
9689 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
9690 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
9691 # Balancers. This option is not available publicly.
9692 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
9693 # matching traffic (in seconds).
9694 #
9695 # For internal passthrough Network Load Balancers:
9696 #
9697 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
9698 # - It can be set only if Connection Tracking is less than 5-tuple
9699 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
9700 # Mode is PER_SESSION).
9701 #
9702 #
9703 #
9704 # For external passthrough Network Load Balancers the default is 60
9705 # seconds. This option is not available publicly.
9706 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
9707 # options:
9708 #
9709 # - PER_CONNECTION: This is the default mode. The Connection
9710 # Tracking is performed as per the Connection Key (default Hash Method) for
9711 # the specific protocol.
9712 # - PER_SESSION: The Connection Tracking is performed as per
9713 # the configured Session Affinity. It matches the configured Session
9714 # Affinity.
9715 #
9716 #
9717 #
9718 # For more details, see [Tracking Mode for Network Load
9719 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
9720 # and [Tracking Mode for Internal TCP/UDP Load
9721 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
9722 },
9723 &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
9724 # affinity based on HTTP headers, cookies or other properties. This load
9725 # balancing policy is applicable only for HTTP connections. The affinity to a
9726 # particular destination host will be lost when one or more hosts are
9727 # added/removed from the destination service. This field specifies parameters
9728 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
9729 #
9730 # This field is applicable to either:
9731 #
9732 # - A regional backend service with the service protocol set to HTTP,
9733 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
9734 # INTERNAL_MANAGED.
9735 # - A global backend service with the
9736 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
9737 &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
9738 # be used as the hash key for the consistent hash load balancer. If the
9739 # cookie is not present, it will be generated. This field is applicable if
9740 # the sessionAffinity is set to HTTP_COOKIE.
9741 #
9742 # Not supported when the backend service is referenced by a URL map that is
9743 # bound to target gRPC proxy that has validateForProxyless field set to true.
9744 # for load balancing policies that use a consistent hash.
9745 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
9746 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
9747 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
9748 # as a count of seconds and fractions of seconds at nanosecond
9749 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9750 # or &quot;month&quot;. Range is approximately 10,000 years.
9751 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9752 # Durations less than one second are represented with a 0
9753 # `seconds` field and a positive `nanos` field. Must be from 0
9754 # to 999,999,999 inclusive.
9755 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9756 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9757 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9758 },
9759 },
9760 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
9761 # applicable if the sessionAffinity is set toHEADER_FIELD.
9762 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
9763 # 1024. Larger ring sizes result in more granular load distributions. If the
9764 # number of hosts in the load balancing pool is larger than the ring size,
9765 # each host will be assigned a single virtual node.
9766 },
9767 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
9768 # text format.
9769 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
9770 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
9771 # locality_lb_policy.
9772 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
9773 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
9774 # long and match the regular expression
9775 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
9776 # first character must be a lowercase letter, and all following
9777 # characters must be a dash, period, underscore, lowercase letter, or
9778 # digit, except the last character, which cannot be a dash, period, or
9779 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
9780 # field can only be used for a global or regional backend service with the
9781 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
9782 },
9783 ],
9784 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
9785 # custom
9786 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
9787 &quot;A String&quot;,
9788 ],
9789 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
9790 # custom
9791 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
9792 &quot;A String&quot;,
9793 ],
9794 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9795 # create the resource.
9796 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
9797 # this backend service.
9798 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
9799 # global external Application Load Balancer.
9800 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
9801 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
9802 #
9803 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
9804 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
9805 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
9806 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
9807 # externalManagedMigrationTestingPercentage.
9808 #
9809 # Rolling back a migration requires the states to be set in reverse order. So
9810 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
9811 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
9812 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
9813 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
9814 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
9815 # external Application Load Balancer.
9816 #
9817 # The value of this field must be in the range [0, 100].
9818 #
9819 # Session affinity options will slightly affect this routing behavior, for
9820 # more details, see:Session
9821 # Affinity.
9822 #
9823 # This value can only be set if the loadBalancingScheme in the BackendService
9824 # is set to EXTERNAL (when using the classic Application Load Balancer) and
9825 # the migration state is TEST_BY_PERCENTAGE.
9826 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
9827 # as a backup (failover) backend.
9828 # For load balancers that have configurable failover:
9829 # [Internal passthrough Network Load
9830 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9831 # and [external passthrough Network Load
9832 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9833 #
9834 # failoverPolicy cannot be specified with haPolicy.
9835 # failover:
9836 # [Internal passthrough Network Load
9837 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9838 # and [external passthrough
9839 # Network Load
9840 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9841 # On failover or failback, this field indicates whether connection draining
9842 # will be honored. Google Cloud has a fixed connection draining timeout of
9843 # 10 minutes. A setting of true terminates existing TCP
9844 # connections to the active pool during failover and failback, immediately
9845 # draining traffic. A setting of false allows existing TCP
9846 # connections to persist, even on VMs no longer in the active pool, for up
9847 # to the duration of the connection draining timeout (10 minutes).
9848 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
9849 #
9850 # The default is false.
9851 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
9852 # load balancer are dropped when all primary and all backup backend VMs are
9853 # unhealthy.If set to false, connections are distributed
9854 # among all primary VMs when all primary and all backup backend VMs are
9855 # unhealthy.
9856 # For load balancers that have configurable
9857 # failover:
9858 # [Internal passthrough
9859 # Network Load
9860 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9861 # and [external passthrough
9862 # Network Load
9863 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9864 # The default is false.
9865 &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
9866 # failover when the number of healthy primary VMs equals zero.
9867 # For all other values, the load balancer performs a failover when the
9868 # total number of healthy primary VMs is less than this ratio.
9869 # For load balancers that have configurable
9870 # failover:
9871 # [Internal TCP/UDP Load
9872 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9873 # and [external TCP/UDP Load
9874 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9875 },
9876 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
9877 # This field is used in optimistic locking. This field will be ignored when
9878 # inserting a BackendService. An up-to-date fingerprint must be provided in
9879 # order to update the BackendService, otherwise the request will
9880 # fail with error 412 conditionNotMet.
9881 #
9882 # To see the latest fingerprint, make a get() request to
9883 # retrieve a BackendService.
9884 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
9885 # Protocol Forwarding.
9886 #
9887 # The backends of this regional backend service must only specify zonal
9888 # network endpoint groups (NEGs) of type GCE_VM_IP.
9889 #
9890 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
9891 # regional backend service must set the network field. All zonal NEGs must
9892 # belong to the same network. However, individual NEGs can
9893 # belong to different subnetworks of that network.
9894 #
9895 # When haPolicy is specified, the set of attached network endpoints across
9896 # all backends comprise an High Availability domain from which one endpoint
9897 # is selected as the active endpoint (the leader) that receives all
9898 # traffic.
9899 #
9900 # haPolicy can be added only at backend service creation time. Once set up,
9901 # it cannot be deleted.
9902 #
9903 # Note that haPolicy is not for load balancing, and therefore cannot be
9904 # specified with sessionAffinity, connectionTrackingPolicy, and
9905 # failoverPolicy.
9906 #
9907 # haPolicy requires customers to be responsible for tracking backend
9908 # endpoint health and electing a leader among the healthy endpoints.
9909 # Therefore, haPolicy cannot be specified with healthChecks.
9910 #
9911 # haPolicy can only be specified for External Passthrough Network Load
9912 # Balancers and Internal Passthrough Network Load Balancers.
9913 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
9914 # achieve it.
9915 #
9916 # Supported values are:
9917 #
9918 # - DISABLED: Fast IP Move is disabled. You can only use the
9919 # haPolicy.leader API to update the leader.
9920 # - &gt;GARP_RA: Provides a method to very quickly define a new network
9921 # endpoint as the leader. This method is faster than updating the leader
9922 # using the haPolicy.leader API. Fast IP move works as follows: The VM
9923 # hosting the network endpoint that should become the new leader sends
9924 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
9925 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
9926 # temporarily associates the forwarding rule IP address with that VM, and
9927 # both new and in-flight packets are quickly delivered to that VM.
9928 #
9929 #
9930 #
9931 # Note the important properties of the Fast IP Move functionality:
9932 #
9933 # - The GARP/RA-initiated re-routing stays active for approximately 20
9934 # minutes. After triggering fast failover, you must also
9935 # appropriately set the haPolicy.leader.
9936 # - The new leader instance should continue to send GARP/RA packets
9937 # periodically every 10 seconds until at least 10 minutes after updating
9938 # the haPolicy.leader (but stop immediately if it is no longer the leader).
9939 # - After triggering a fast failover, we recommend that you wait at least
9940 # 3 seconds before sending another GARP/RA packet from a different VM
9941 # instance to avoid race conditions.
9942 # - Don&#x27;t send GARP/RA packets from different VM
9943 # instances at the same time. If multiple instances continue to send
9944 # GARP/RA packets, traffic might be routed to different destinations in an
9945 # alternating order. This condition ceases when a single instance
9946 # issues a GARP/RA packet.
9947 # - The GARP/RA request always takes priority over the leader API.
9948 # Using the haPolicy.leader API to change the leader to a different
9949 # instance will have no effect until the GARP/RA request becomes
9950 # inactive.
9951 # - The GARP/RA packets should follow the GARP/RA
9952 # Packet Specifications..
9953 # - When multiple forwarding rules refer to a regional backend service,
9954 # you need only send a GARP or RA packet for a single forwarding rule
9955 # virtual IP. The virtual IPs for all forwarding rules targeting the same
9956 # backend service will also be moved to the sender of the GARP or RA
9957 # packet.
9958 #
9959 #
9960 #
9961 # The following are the Fast IP Move limitations (that is, when fastIPMove
9962 # is not DISABLED):
9963 #
9964 # - Multiple forwarding rules cannot use the same IP address if one of
9965 # them refers to a regional backend service with fastIPMove.
9966 # - The regional backend service must set the network field, and all
9967 # NEGs must belong to that network. However, individual
9968 # NEGs can belong to different subnetworks of that network.
9969 # - The maximum number of network endpoints across all backends of a
9970 # backend service with fastIPMove is 32.
9971 # - The maximum number of backend services with fastIPMove that can have
9972 # the same network endpoint attached to one of its backends is 64.
9973 # - The maximum number of backend services with fastIPMove in a VPC in a
9974 # region is 64.
9975 # - The network endpoints that are attached to a backend of a backend
9976 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
9977 # - Traffic directed to the leader by a static route next hop will not be
9978 # redirected to a new leader by fast failover. Such traffic will only be
9979 # redirected once an haPolicy.leader update has taken effect. Only traffic
9980 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
9981 # fast failover.
9982 #
9983 #
9984 # haPolicy.fastIPMove can be set only at backend service creation time.
9985 # Once set, it cannot be updated.
9986 #
9987 # By default, fastIpMove is set to DISABLED.
9988 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
9989 # this service as the active endpoint (the leader) that receives all
9990 # traffic.
9991 #
9992 # When the leader changes, there is no connection draining to persist
9993 # existing connections on the old leader.
9994 #
9995 # You are responsible for selecting a suitable endpoint as the
9996 # leader. For example, preferring a healthy endpoint over unhealthy ones.
9997 # Note that this service does not track backend endpoint health, and
9998 # selects the configured leader unconditionally.
9999 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
10000 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
10001 # that the leader is attached to.
10002 #
10003 # The leader&#x27;s backendGroup must already be specified as a backend of
10004 # this backend service. Removing a backend that is designated as the
10005 # leader&#x27;s backendGroup is not permitted.
10006 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
10007 # designated as the leader.
10008 #
10009 # This network endpoint cannot be detached from the NEG specified in
10010 # the haPolicy.leader.backendGroup until the leader is updated with
10011 # another network endpoint, or the leader is removed from the haPolicy.
10012 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
10013 # instance must already be attached to the NEG specified in the
10014 # haPolicy.leader.backendGroup.
10015 #
10016 # The name must be 1-63 characters long, and comply with RFC1035.
10017 # Authorization requires the following IAM permission on the
10018 # specified resource instance: compute.instances.use
10019 },
10020 },
10021 },
10022 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
10023 # httpsHealthChecks (legacy) resource for health checking this backend
10024 # service. Not all backend services support legacy health checks. See
10025 # Load balancer guide. Currently, at most one health check can be
10026 # specified for each backend service. Backend services with
10027 # instance group or zonal NEG backends must have a health check unless
10028 # haPolicy is specified. Backend services with internet or serverless NEG
10029 # backends must not have a health check.
10030 #
10031 # healthChecks[] cannot be specified with haPolicy.
10032 &quot;A String&quot;,
10033 ],
10034 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
10035 # Not available for internal passthrough Network Load Balancers and external
10036 # passthrough Network Load Balancers.
10037 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
10038 # incoming requests.
10039 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
10040 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
10041 # For security reasons, this value cannot be retrieved via the API.
10042 # Instead, the SHA-256 hash of the value is returned in the
10043 # oauth2ClientSecretSha256 field.
10044 #
10045 # @InputOnly
10046 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
10047 },
10048 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
10049 # defined by the server.
10050 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
10051 # from the client to the backend for proxyless gRPC).
10052 # The possible values are:
10053 #
10054 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
10055 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10056 # Group), regardless of traffic from the client to the proxy. Only IPv4
10057 # health checks are used to check the health of the backends. This is the
10058 # default setting.
10059 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
10060 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
10061 # address).
10062 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
10063 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10064 # Group), regardless of traffic from the client to the proxy. Only IPv6
10065 # health checks are used to check the health of the backends.
10066 #
10067 #
10068 #
10069 # This field is applicable to either:
10070 #
10071 # - Advanced global external Application Load Balancer (load balancing
10072 # scheme EXTERNAL_MANAGED),
10073 # - Regional external Application Load
10074 # Balancer,
10075 # - Internal proxy Network Load Balancer (load balancing
10076 # scheme INTERNAL_MANAGED),
10077 # - Regional internal Application Load
10078 # Balancer (load balancing scheme INTERNAL_MANAGED),
10079 # - Traffic
10080 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
10081 # INTERNAL_SELF_MANAGED).
10082 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
10083 # for backend services.
10084 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
10085 # created for one type of load balancer cannot be used with another.
10086 # For more information, refer toChoosing
10087 # a load balancer.
10088 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
10089 # preference. When you use localityLbPolicies, you must set at least one
10090 # value for either the localityLbPolicies[].policy or the
10091 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
10092 # value set in the localityLbPolicy field.
10093 #
10094 # For an example of how to use this field, seeDefine
10095 # a list of preferred policies.
10096 #
10097 # Caution: This field and its children are intended for use in a service mesh
10098 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
10099 # that have this configuration.
10100 { # Container for either a built-in LB policy supported by gRPC or Envoy or
10101 # a custom one implemented by the end user.
10102 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
10103 # deployed with the client.
10104 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
10105 # by a locally installed custom policy implementation.
10106 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
10107 #
10108 # The value should match the name of a custom implementation registered
10109 # on the gRPC clients. It should follow protocol buffer message naming
10110 # conventions and include the full path (for example,
10111 # myorg.CustomLbPolicy). The maximum length is 256 characters.
10112 #
10113 # Do not specify the same custom policy more than once for a
10114 # backend. If you do, the configuration is rejected.
10115 #
10116 # For an example of how to use this field, seeUse
10117 # a custom policy.
10118 },
10119 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
10120 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
10121 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
10122 # about these values, see the description of localityLbPolicy.
10123 #
10124 # Do not specify the same policy more than once for a
10125 # backend. If you do, the configuration is rejected.
10126 },
10127 },
10128 ],
10129 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
10130 # possible values are:
10131 #
10132 # - ROUND_ROBIN: This is a simple policy in which each healthy
10133 # backend is selected in round robin order. This is the default.
10134 # - LEAST_REQUEST: An O(1) algorithm which
10135 # selects two random healthy hosts and picks the host which has fewer active
10136 # requests.
10137 # - RING_HASH: The ring/modulo hash load balancer implements
10138 # consistent hashing to backends. The algorithm has the property that the
10139 # addition/removal of a host from a set of N hosts only affects 1/N of the
10140 # requests.
10141 # - RANDOM: The load balancer selects a random healthy
10142 # host.
10143 # - ORIGINAL_DESTINATION: Backend host is selected
10144 # based on the client connection metadata, i.e., connections are opened to
10145 # the same address as the destination address of the incoming connection
10146 # before the connection was redirected to the load balancer.
10147 # - MAGLEV: used as a drop in replacement for the ring hash
10148 # load balancer. Maglev is not as stable as ring hash but has faster table
10149 # lookup build times and host selection times. For more information about
10150 # Maglev, see Maglev:
10151 # A Fast and Reliable Software Network Load Balancer.
10152 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
10153 # Load Balancing using weights computed from Backend reported Custom Metrics.
10154 # If set, the Backend Service responses are expected to contain non-standard
10155 # HTTP response header field Endpoint-Load-Metrics. The reported
10156 # metrics to use for computing the weights are specified via thecustomMetrics field.
10157 #
10158 # This field is applicable to either:
10159 # - A regional backend service with the service protocol set to HTTP,
10160 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10161 # INTERNAL_MANAGED.
10162 # - A global backend service with the
10163 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
10164 # EXTERNAL_MANAGED.
10165 #
10166 #
10167 # If sessionAffinity is not configured—that is, if session
10168 # affinity remains at the default value of NONE—then the
10169 # default value for localityLbPolicy
10170 # is ROUND_ROBIN. If session affinity is set to a value other
10171 # than NONE,
10172 # then the default value for localityLbPolicy isMAGLEV.
10173 #
10174 # Only ROUND_ROBIN and RING_HASH are supported
10175 # when the backend service is referenced by a URL map that is bound to
10176 # target gRPC proxy that has validateForProxyless field set to true.
10177 #
10178 # localityLbPolicy cannot be specified with haPolicy.
10179 &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
10180 # by this backend service. If logging is enabled, logs will be exported to
10181 # Stackdriver.
10182 # backend service.
10183 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
10184 # traffic served by this backend service. The default value is false.
10185 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
10186 { # Determines which HTTP headers will be logged to Stackdriver.
10187 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10188 },
10189 ],
10190 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
10191 { # Determines which HTTP headers will be logged to Stackdriver.
10192 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10193 },
10194 ],
10195 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
10196 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
10197 # of optional fields you want to include in the logs. For example:
10198 # serverInstance, serverGkeDetails.cluster,
10199 # serverGkeDetails.pod.podNamespace
10200 &quot;A String&quot;,
10201 ],
10202 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
10203 # service. Configures whether all, none or a subset of optional fields
10204 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
10205 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
10206 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
10207 # service. The value of the field must be in [0, 1]. This configures the
10208 # sampling rate of requests to the load balancer where 1.0 means all logged
10209 # requests are reported and 0.0 means no logged requests are reported. The
10210 # default value is 1.0.
10211 },
10212 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
10213 # service. Duration is computed from the beginning of the stream until the
10214 # response has been completely processed, including all retries. A stream
10215 # that does not complete in this duration is closed.
10216 #
10217 # If not specified, there will be no timeout limit, i.e. the maximum
10218 # duration is infinite.
10219 #
10220 # This value can be overridden in the PathMatcher configuration of the
10221 # UrlMap that references this backend service.
10222 #
10223 # This field is only allowed when the loadBalancingScheme of
10224 # the backend service is INTERNAL_SELF_MANAGED.
10225 # as a count of seconds and fractions of seconds at nanosecond
10226 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10227 # or &quot;month&quot;. Range is approximately 10,000 years.
10228 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10229 # Durations less than one second are represented with a 0
10230 # `seconds` field and a positive `nanos` field. Must be from 0
10231 # to 999,999,999 inclusive.
10232 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10233 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10234 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10235 },
10236 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
10237 # controller and read by the backend RCTH
10238 &quot;a_key&quot;: &quot;A String&quot;,
10239 },
10240 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
10241 # The name must be 1-63 characters long, and comply withRFC1035.
10242 # Specifically, the name must be 1-63 characters long and match the regular
10243 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10244 # character must be a lowercase letter, and all following characters must
10245 # be a dash, lowercase letter, or digit, except the last character, which
10246 # cannot be a dash.
10247 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
10248 #
10249 # This field must be set for Internal Passthrough Network Load Balancers when
10250 # the haPolicy is enabled, and for External Passthrough Network Load
10251 # Balancers when the haPolicy fastIpMove is enabled.
10252 #
10253 # 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.
10254 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
10255 # Load Balancers.
10256 #
10257 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
10258 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
10259 # endpoints in the local zone.
10260 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
10261 # possible values are:
10262 #
10263 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
10264 # is disabled. The load balancer distributes new connections to all
10265 # healthy backend endpoints across all zones.
10266 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
10267 # enabled. The load balancer distributes new connections to all healthy
10268 # backend endpoints in the local zone only. If there are no healthy
10269 # backend endpoints in the local zone, the load balancer distributes
10270 # new connections to all backend endpoints in the local zone.
10271 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
10272 # enabled. The load balancer distributes new connections to all healthy
10273 # backend endpoints in the local zone only. If there aren&#x27;t enough
10274 # healthy backend endpoints in the local zone, the load balancer
10275 # distributes new connections to all healthy backend endpoints across all
10276 # zones.
10277 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
10278 # of healthy backend endpoints in a zone to the count of backend
10279 # endpoints in that same zone is equal to or above this threshold, the
10280 # load balancer distributes new connections to all healthy endpoints in
10281 # the local zone only. When the ratio of the count of healthy backend
10282 # endpoints in a zone to the count of backend endpoints in that same
10283 # zone is below this threshold, the load balancer distributes all new
10284 # connections to all healthy endpoints across all zones.
10285 },
10286 },
10287 &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.
10288 # the backend service.
10289 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
10290 # service.
10291 },
10292 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
10293 # load balancing pool of each individual proxy instance that processes the
10294 # traffic for the given backend service. If not set, this feature is
10295 # considered disabled.
10296 #
10297 # Results of the outlier detection algorithm (ejection of endpoints from the
10298 # load balancing pool and returning them back to the pool) are executed
10299 # independently by each proxy instance of the load balancer. In most cases,
10300 # more than one proxy instance handles the traffic received by a backend
10301 # service. Thus, it is possible that an unhealthy endpoint is detected and
10302 # ejected by only some of the proxies, and while this happens, other proxies
10303 # may continue to send requests to the same unhealthy endpoint until they
10304 # detect and eject the unhealthy endpoint.
10305 #
10306 # Applicable backend endpoints can be:
10307 #
10308 # - VM instances in an Instance Group
10309 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
10310 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
10311 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
10312 # Functions Services
10313 # - Private Service Connect NEGs, that resolve to
10314 # Google-managed regional API endpoints or managed services published using
10315 # Private Service Connect
10316 #
10317 #
10318 #
10319 # Applicable backend service types can be:
10320 #
10321 # - A global backend service with the loadBalancingScheme set to
10322 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
10323 # - A regional backend
10324 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
10325 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
10326 # supported for Serverless NEGs.
10327 #
10328 #
10329 #
10330 # Not supported when the backend service is referenced by a URL map that is
10331 # bound to target gRPC proxy that has validateForProxyless field set to true.
10332 # pool for the backend service.
10333 &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
10334 # or 30s.
10335 #
10336 # After a backend endpoint is returned back to the load balancing pool, it
10337 # can be ejected again in another ejection analysis. Thus, the total ejection
10338 # time is equal to the base ejection time multiplied by the number of times
10339 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
10340 # as a count of seconds and fractions of seconds at nanosecond
10341 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10342 # or &quot;month&quot;. Range is approximately 10,000 years.
10343 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10344 # Durations less than one second are represented with a 0
10345 # `seconds` field and a positive `nanos` field. Must be from 0
10346 # to 999,999,999 inclusive.
10347 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10348 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10349 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10350 },
10351 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
10352 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
10353 # return code qualifies as an error. Defaults to 5.
10354 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
10355 # connection errors that are mapped to one of those status codes) before a
10356 # consecutive gateway failure ejection occurs. Defaults to 3.
10357 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10358 # outlier status is detected through consecutive 5xx. This setting can be
10359 # used to disable ejection or to ramp it up slowly. Defaults to 0.
10360 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10361 # outlier status is detected through consecutive gateway failures. This
10362 # setting can be used to disable ejection or to ramp it up slowly. Defaults
10363 # to 100.
10364 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10365 # outlier status is detected through success rate statistics. This setting
10366 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
10367 #
10368 # Not supported when the backend service uses Serverless NEG.
10369 &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
10370 # ejections and backend endpoints being returned to service. The interval is
10371 # equal to the number of seconds as defined in
10372 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
10373 # in outlierDetection.interval.nanos. Defaults to 1 second.
10374 # as a count of seconds and fractions of seconds at nanosecond
10375 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10376 # or &quot;month&quot;. Range is approximately 10,000 years.
10377 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10378 # Durations less than one second are represented with a 0
10379 # `seconds` field and a positive `nanos` field. Must be from 0
10380 # to 999,999,999 inclusive.
10381 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10382 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10383 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10384 },
10385 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
10386 # backend service that can be ejected if the ejection conditions are met.
10387 # Defaults to 50%.
10388 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
10389 # enough request volume to detect success rate outliers. If the number of
10390 # backend endpoints is fewer than this setting, outlier detection via success
10391 # rate statistics is not performed for any backend endpoint in the load
10392 # balancing pool. Defaults to 5.
10393 #
10394 # Not supported when the backend service uses Serverless NEG.
10395 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
10396 # (as defined by the interval duration above) to include this backend
10397 # endpoint in success rate based outlier detection. If the volume is lower
10398 # than this setting, outlier detection via success rate statistics is not
10399 # performed for that backend endpoint. Defaults to 100.
10400 #
10401 # Not supported when the backend service uses Serverless NEG.
10402 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
10403 # outlier ejection. The ejection threshold is the difference between the mean
10404 # success rate, and the product of this factor and the standard deviation of
10405 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
10406 # is divided by a thousand to get a double. That is, if the desired factor
10407 # is 1.9, the runtime value should be 1900. Defaults to 1900.
10408 #
10409 # Not supported when the backend service uses Serverless NEG.
10410 },
10411 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
10412 # as part of resource payload.
10413 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
10414 # Tag keys and values have the same definition as resource
10415 # manager tags. The field is allowed for INSERT
10416 # only. The keys/values to set on the resource should be specified in
10417 # either ID { : } or Namespaced format
10418 # { : }.
10419 # For example the following are valid inputs:
10420 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
10421 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
10422 # Note:
10423 # * Invalid combinations of ID &amp; namespaced format is not supported. For
10424 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
10425 &quot;a_key&quot;: &quot;A String&quot;,
10426 },
10427 },
10428 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
10429 # the backend. The default value is 80.
10430 # For internal passthrough Network Load Balancers and external passthrough
10431 # Network Load Balancers, omit port.
10432 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
10433 # communication to the backend VMs in that group. The
10434 # named port must be [defined on each backend instance
10435 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
10436 # This parameter has no meaning if the backends are NEGs. For internal
10437 # passthrough Network Load Balancers and external passthrough Network Load
10438 # Balancers, omit port_name.
10439 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
10440 # with backends.
10441 #
10442 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
10443 # depending on the chosen load balancer or Traffic Director configuration.
10444 # Refer to the documentation for the load balancers or for Traffic Director
10445 # for more information.
10446 #
10447 # Must be set to GRPC when the backend service is referenced by a URL map
10448 # that is bound to target gRPC proxy.
10449 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
10450 # resides. This field is not applicable to global backend services.
10451 # You must specify this field as part of the HTTP request URL. It is
10452 # not settable as a field in the request body.
10453 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
10454 # backend service.
10455 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
10456 # service. This field is applicable to a global backend service with the
10457 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
10458 &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
10459 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
10460 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
10461 # private storage buckets that support Signature Version 4 for authentication.
10462 # The service name for generating the authentication header will always default
10463 # to &#x27;s3&#x27;.
10464 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
10465 # creating a backend that uses AWS v4 signature authentication, but will not
10466 # be returned as part of the configuration when queried with a REST API GET
10467 # request.
10468 #
10469 # @InputOnly
10470 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
10471 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
10472 # keep track of different iterations of your access key.
10473 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
10474 # the name of the region your cloud uses to host your origin. For example,
10475 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
10476 },
10477 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
10478 # that describes how clients should authenticate with this service&#x27;s
10479 # backends.
10480 #
10481 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
10482 # to INTERNAL_SELF_MANAGED.
10483 #
10484 # If left blank, communications are not encrypted.
10485 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
10486 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
10487 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
10488 # specified values, the communication continues. Otherwise, it fails. This
10489 # additional check enables the client to verify that the server is authorized
10490 # to run the requested service.
10491 #
10492 # Note that the contents of the server
10493 # certificate&#x27;s subjectAltName field are configured by the
10494 # Public Key Infrastructure which provisions server identities.
10495 #
10496 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
10497 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
10498 # mode).
10499 &quot;A String&quot;,
10500 ],
10501 },
10502 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10503 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
10504 #
10505 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
10506 # If set, lists of backends and health checks must be both empty.
10507 &quot;A String&quot;,
10508 ],
10509 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
10510 #
10511 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
10512 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
10513 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
10514 #
10515 # Only NONE and HEADER_FIELD are supported
10516 # when the backend service is referenced by a URL map that is bound to
10517 # target gRPC proxy that has validateForProxyless field set to true.
10518 #
10519 # For more details, see:
10520 # [Session
10521 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
10522 #
10523 # sessionAffinity cannot be specified with haPolicy.
10524 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
10525 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
10526 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
10527 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
10528 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
10529 # as a count of seconds and fractions of seconds at nanosecond
10530 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10531 # or &quot;month&quot;. Range is approximately 10,000 years.
10532 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10533 # Durations less than one second are represented with a 0
10534 # `seconds` field and a positive `nanos` field. Must be from 0
10535 # to 999,999,999 inclusive.
10536 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10537 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10538 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10539 },
10540 },
10541 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
10542 # Currently this is applicable only for Internal TCP/UDP load balancing,
10543 # Internal HTTP(S) load balancing and Traffic Director.
10544 &quot;policy&quot;: &quot;A String&quot;,
10545 },
10546 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
10547 # type of load balancer. For more information see,
10548 # Backend service settings.
10549 # The default is 30 seconds.
10550 # The full range of timeout values allowed goes from 1
10551 # through 2,147,483,647 seconds.
10552 #
10553 # This value can be overridden in the PathMatcher configuration of the
10554 # UrlMap that references this backend service.
10555 #
10556 # Not supported when the backend service is referenced by a URL map that is
10557 # bound to target gRPC proxy that has validateForProxyless field set to true.
10558 # Instead, use maxStreamDuration.
10559 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
10560 # when the backend protocol is SSL, HTTPS or HTTP2.
10561 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
10562 # networksecurity.googleapis.com namespace. Can be used in authenticating
10563 # TLS connections to the backend, as specified by the authenticationMode
10564 # field. Can only be specified if authenticationMode is not NONE.
10565 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
10566 # balancer sends this string as the SNI hostname in the TLS connection to
10567 # the backend, and requires that this string match a Subject Alternative
10568 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
10569 # NEG backend, if the SNI is specified here, the load balancer uses it
10570 # regardless of whether the Regional Internet NEG is specified with FQDN or
10571 # IP address and port. When both sni and subjectAltNames[] are specified,
10572 # the load balancer matches the backend certificate&#x27;s SAN only to
10573 # subjectAltNames[].
10574 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
10575 # verifies during a TLS handshake with the backend. When the server
10576 # presents its X.509 certificate to the Load Balancer, the Load Balancer
10577 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
10578 # match one of the subjectAltNames in the list. This field is limited to 5
10579 # entries. When both sni and subjectAltNames[] are specified, the load
10580 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
10581 { # A Subject Alternative Name that the load balancer matches against the SAN
10582 # field in the TLS certificate provided by the backend, specified as either
10583 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
10584 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
10585 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
10586 },
10587 ],
10588 },
10589 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
10590 {
10591 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
10592 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
10593 # and ForwardingRule.
10594 },
10595 ],
10596 }
10597
10598 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
10599 that if you must retry your request, the server will know to ignore the
10600 request if it has already been completed.
10601
10602 For example, consider a situation where you make an initial request and
10603 the request times out. If you make the request again with the same
10604 request ID, the server can check if original operation with the same
10605 request ID was received, and if so, will ignore the second request. This
10606 prevents clients from accidentally creating duplicate commitments.
10607
10608 The request ID must be
10609 a valid UUID with the exception that zero UUID is not supported
10610 (00000000-0000-0000-0000-000000000000).
10611 x__xgafv: string, V1 error format.
10612 Allowed values
10613 1 - v1 error format
10614 2 - v2 error format
10615
10616 Returns:
10617 An object of the form:
10618
10619 { # Represents an Operation resource.
10620 #
10621 # Google Compute Engine has three Operation resources:
10622 #
10623 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
10624 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
10625 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
10626 #
10627 # You can use an operation resource to manage asynchronous API requests.
10628 # For more information, readHandling
10629 # API responses.
10630 #
10631 # Operations can be global, regional or zonal.
10632 #
10633 # - For global operations, use the `globalOperations`
10634 # resource.
10635 # - For regional operations, use the
10636 # `regionOperations` resource.
10637 # - For zonal operations, use
10638 # the `zoneOperations` resource.
10639 #
10640 #
10641 #
10642 # For more information, read
10643 # Global, Regional, and Zonal Resources.
10644 #
10645 # Note that completed Operation resources have a limited
10646 # retention period.
10647 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
10648 # Not present otherwise.
10649 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
10650 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
10651 # set when the operation is created.
10652 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
10653 # text format.
10654 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
10655 # this field will be populated.
10656 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
10657 # operation.
10658 {
10659 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
10660 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
10661 # details. There is a set of defined message types to use for providing
10662 # details.The syntax depends on the error code. For example,
10663 # QuotaExceededInfo will have details when the error code is
10664 # QUOTA_EXCEEDED.
10665 {
10666 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
10667 #
10668 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
10669 # is not enabled:
10670 #
10671 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
10672 # &quot;domain&quot;: &quot;googleapis.com&quot;
10673 # &quot;metadata&quot;: {
10674 # &quot;resource&quot;: &quot;projects/123&quot;,
10675 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
10676 # }
10677 # }
10678 #
10679 # This response indicates that the pubsub.googleapis.com API is not enabled.
10680 #
10681 # Example of an error that is returned when attempting to create a Spanner
10682 # instance in a region that is out of stock:
10683 #
10684 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10685 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10686 # &quot;metadata&quot;: {
10687 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10688 # }
10689 # }
10690 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10691 # is typically the registered service name of the tool or product that
10692 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10693 # generated by some common infrastructure, the error domain must be a
10694 # globally unique value that identifies the infrastructure. For Google API
10695 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10696 &quot;metadatas&quot;: { # Additional structured details about this error.
10697 #
10698 # Keys must match a regular expression of `a-z+` but should
10699 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10700 # length. When identifying the current value of an exceeded limit, the units
10701 # should be contained in the key, not the value. For example, rather than
10702 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10703 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10704 # instances that can be created in a single (batch) request.
10705 &quot;a_key&quot;: &quot;A String&quot;,
10706 },
10707 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10708 # proximate cause of the error. Error reasons are unique within a particular
10709 # domain of errors. This should be at most 63 characters and match a
10710 # regular expression of `A-Z+[A-Z0-9]`, which represents
10711 # UPPER_SNAKE_CASE.
10712 },
10713 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10714 #
10715 # For example, if a quota check failed with an error indicating the calling
10716 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10717 # directly to the right place in the developer console to flip the bit.
10718 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10719 { # Describes a URL link.
10720 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10721 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10722 },
10723 ],
10724 },
10725 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10726 # which can be attached to an RPC error.
10727 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10728 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10729 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10730 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10731 },
10732 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10733 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10734 &quot;a_key&quot;: &quot;A String&quot;,
10735 },
10736 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10737 # type or metric.
10738 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10739 # or metric.
10740 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10741 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10742 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10743 },
10744 },
10745 ],
10746 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10747 # This property is optional.
10748 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10749 },
10750 ],
10751 },
10752 &quot;getVersionOperationMetadata&quot;: {
10753 &quot;inlineSbomInfo&quot;: {
10754 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10755 # appropriate identifiers.
10756 &quot;a_key&quot;: &quot;A String&quot;,
10757 },
10758 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10759 # identifiers.
10760 &quot;a_key&quot;: &quot;A String&quot;,
10761 },
10762 },
10763 },
10764 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10765 # message that was returned, such as `NOT FOUND`.
10766 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10767 # status code that was returned. For example, a `404` means the
10768 # resource was not found.
10769 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10770 # defined by the server.
10771 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10772 # This value is inRFC3339
10773 # text format.
10774 &quot;instancesBulkInsertOperationMetadata&quot;: {
10775 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10776 # Example key: zones/us-central1-a
10777 &quot;a_key&quot;: {
10778 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10779 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10780 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10781 # error.
10782 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10783 # if the flow is rolling forward or rolling back.
10784 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10785 },
10786 },
10787 },
10788 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10789 # Operation resources.
10790 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10791 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10792 # group of operations results from a `bulkInsert` API request.
10793 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10794 # `update`, or `delete`, and so on.
10795 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10796 # There is no requirement that this be linear or support any granularity of
10797 # operations. This should not be used to guess when the operation will be
10798 # complete. This number should monotonically increase as the operation
10799 # progresses.
10800 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10801 # applicable when performing regional operations.
10802 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10803 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10804 # this field will contain information on all underlying zonal actions and
10805 # their state.
10806 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10807 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10808 # Example key: zones/us-central1-a
10809 &quot;a_key&quot;: {
10810 &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
10811 # populated.
10812 # different programming environments, including REST APIs and RPC APIs. It is
10813 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10814 # three pieces of data: error code, error message, and error details.
10815 #
10816 # You can find out more about this error model and how to work with it in the
10817 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10818 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10819 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10820 # message types for APIs to use.
10821 {
10822 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10823 },
10824 ],
10825 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10826 # user-facing error message should be localized and sent in the
10827 # google.rpc.Status.details field, or localized by the client.
10828 },
10829 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10830 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10831 },
10832 },
10833 },
10834 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10835 # This value is inRFC3339
10836 # text format.
10837 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10838 # following:
10839 # `PENDING`, `RUNNING`, or `DONE`.
10840 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10841 # operation.
10842 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10843 # of the target resource.
10844 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10845 # operations related to creating a snapshot, this points to the disk
10846 # that the snapshot was created from.
10847 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10848 # `[email protected]` or
10849 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10850 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10851 # operation, this field will be populated.
10852 {
10853 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10854 # Engine returns NO_RESULTS_ON_PAGE if there
10855 # are no results in the response.
10856 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10857 # value format. For example:
10858 #
10859 # &quot;data&quot;: [
10860 # {
10861 # &quot;key&quot;: &quot;scope&quot;,
10862 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10863 # }
10864 {
10865 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10866 # returned. For example, for warnings where there are no results in a list
10867 # request for a particular zone, this key might be scope and
10868 # the key value might be the zone name. Other examples might be a key
10869 # indicating a deprecated resource and a suggested replacement, or a
10870 # warning about invalid network settings (for example, if an instance
10871 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10872 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10873 },
10874 ],
10875 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10876 },
10877 ],
10878 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10879 # applicable when performing per-zone operations.
10880 }</pre>
10881 </div>
10882
10883 </body></html>