Debian Codegraph @

docs/dyn/compute_alpha.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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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/alpha/globalOperations)
162 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
163 # * [Zonal](/compute/docs/reference/rest/alpha/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;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
342 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
343 # this field will contain information on all underlying zonal actions and
344 # their state.
345 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
346 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
347 # Example key: zones/us-central1-a
348 &quot;a_key&quot;: {
349 &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
350 # populated.
351 # different programming environments, including REST APIs and RPC APIs. It is
352 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
353 # three pieces of data: error code, error message, and error details.
354 #
355 # You can find out more about this error model and how to work with it in the
356 # [API Design Guide](https://cloud.google.com/apis/design/errors).
357 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
358 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
359 # message types for APIs to use.
360 {
361 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
362 },
363 ],
364 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
365 # user-facing error message should be localized and sent in the
366 # google.rpc.Status.details field, or localized by the client.
367 },
368 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
369 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
370 },
371 },
372 },
373 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
374 # This value is inRFC3339
375 # text format.
376 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
377 # following:
378 # `PENDING`, `RUNNING`, or `DONE`.
379 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
380 # operation.
381 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
382 # of the target resource.
383 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
384 # operations related to creating a snapshot, this points to the disk
385 # that the snapshot was created from.
386 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
387 # `[email protected]` or
388 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
389 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
390 # operation, this field will be populated.
391 {
392 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
393 # Engine returns NO_RESULTS_ON_PAGE if there
394 # are no results in the response.
395 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
396 # value format. For example:
397 #
398 # &quot;data&quot;: [
399 # {
400 # &quot;key&quot;: &quot;scope&quot;,
401 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
402 # }
403 {
404 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
405 # returned. For example, for warnings where there are no results in a list
406 # request for a particular zone, this key might be scope and
407 # the key value might be the zone name. Other examples might be a key
408 # indicating a deprecated resource and a suggested replacement, or a
409 # warning about invalid network settings (for example, if an instance
410 # attempts to perform IP forwarding but is not enabled for IP forwarding).
411 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
412 },
413 ],
414 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
415 },
416 ],
417 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
418 # applicable when performing per-zone operations.
419 }</pre>
420 </div>
421
422 <div class="method">
423 <code class="details" id="get">get(project, region, backendService, x__xgafv=None)</code>
424 <pre>Returns the specified regional BackendService resource.
425
426 Args:
427 project: string, Project ID for this request. (required)
428 region: string, Name of the region scoping this request. (required)
429 backendService: string, Name of the BackendService resource to return. (required)
430 x__xgafv: string, V1 error format.
431 Allowed values
432 1 - v1 error format
433 2 - v2 error format
434
435 Returns:
436 An object of the form:
437
438 { # Represents a Backend Service resource.
439 #
440 # A backend service defines how Google Cloud load balancers distribute traffic.
441 # The backend service configuration contains a set of values, such as the
442 # protocol used to connect to backends, various distribution and session
443 # settings, health checks, and timeouts. These settings provide fine-grained
444 # control over how your load balancer behaves. Most of the settings have
445 # default values that allow for easy configuration if you need to get started
446 # quickly.
447 #
448 # Backend services in Google Compute Engine can be either regionally or
449 # globally scoped.
450 #
451 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
452 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
453 #
454 # For more information, seeBackend
455 # Services.
456 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
457 # Load Balancers and Traffic Director and requires
458 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
459 #
460 # If set to 0, the cookie is non-persistent and lasts only until
461 # the end of the browser session (or equivalent). The maximum allowed value
462 # is two weeks (1,209,600).
463 #
464 # Not supported when the backend service is referenced by a URL map that is
465 # bound to target gRPC proxy that has validateForProxyless field set to true.
466 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
467 # load balancing scheme set to INTERNAL_SELF_MANAGED.
468 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
469 { # Message containing information of one individual backend.
470 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
471 # handle additional traffic or is fully loaded. For usage guidelines, see
472 # Connection balancing mode.
473 #
474 # Backends must use compatible balancing modes. For more information, see
475 # Supported balancing modes and target capacity settings and
476 # Restrictions and guidance for instance groups.
477 #
478 # Note: Currently, if you use the API to configure incompatible balancing
479 # modes, the configuration might be accepted even though it has no impact
480 # and is ignored. Specifically, Backend.maxUtilization is ignored when
481 # Backend.balancingMode is RATE. In the future, this incompatible combination
482 # will be rejected.
483 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
484 # mode.
485 # The default value is 1, which means the group serves up to
486 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
487 # completely drained, offering 0% of its available capacity. The valid ranges
488 # are 0.0 and [0.1,1.0].
489 # You cannot configure a setting larger than 0 and smaller than0.1.
490 # You cannot configure a setting of 0 when there is only one
491 # backend attached to the backend service.
492 #
493 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
494 # internet NEGs, regional serverless NEGs, and PSC NEGs.
495 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
496 # BalancingMode.
497 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
498 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
499 # Monitoring, but is not used for load balancing.
500 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
501 # balancing mode. The valid range is [0.0, 1.0].
502 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
503 # long and match the regular expression
504 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
505 # first character must be a lowercase letter, and all following
506 # characters must be a dash, period, underscore, lowercase letter, or
507 # digit, except the last character, which cannot be a dash, period, or
508 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
509 # field can only be used for a global or regional backend service with the
510 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
511 },
512 ],
513 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
514 # create the resource.
515 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
516 # failover backend can be configured for a given BackendService.
517 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
518 # group or network endpoint
519 # group (NEG) resource. To determine what types of backends a load
520 # balancer supports, see the [Backend services
521 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
522 #
523 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
524 # or NEG. Partial URLs are not supported.
525 #
526 # If haPolicy is specified, backends must refer to NEG resources of type
527 # GCE_VM_IP.
528 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
529 # guidelines, seeConnection
530 # balancing mode and Utilization
531 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
532 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
533 # guidelines, seeConnection
534 # balancing mode and Utilization
535 # balancing mode.
536 #
537 # Not available if the backend&#x27;s balancingMode isRATE.
538 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
539 # For usage guidelines, seeConnection
540 # balancing mode and Utilization
541 # balancing mode.
542 #
543 # Not available if the backend&#x27;s balancingMode isRATE.
544 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
545 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
546 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
547 # Not available if backend&#x27;s balancingMode is RATE
548 # or CONNECTION.
549 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
550 # Not available if backend&#x27;s balancingMode is RATE
551 # or CONNECTION.
552 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
553 # usage guidelines, seeRate
554 # balancing mode and Utilization
555 # balancing mode.
556 #
557 # Not available if the backend&#x27;s balancingMode isCONNECTION.
558 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
559 # guidelines, seeRate
560 # balancing mode and Utilization
561 # balancing mode.
562 #
563 # Not available if the backend&#x27;s balancingMode isCONNECTION.
564 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
565 # guidelines, seeRate
566 # balancing mode and Utilization
567 # balancing mode.
568 #
569 # Not available if the backend&#x27;s balancingMode isCONNECTION.
570 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
571 #
572 # For usage guidelines, seeUtilization
573 # balancing mode.
574 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
575 # the backend.
576 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
577 },
578 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
579 # sending traffic to backends with default preference. The possible values
580 # are:
581 #
582 # - PREFERRED: Backends with this preference level will be
583 # filled up to their capacity limits first, based on RTT.
584 # - DEFAULT: If preferred backends don&#x27;t have enough
585 # capacity, backends in this layer would be used and traffic would be
586 # assigned based on the load balancing algorithm you use. This is the
587 # default
588 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
589 # Attachment).
590 # e.g.
591 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
592 # for Cloud Run service.
593 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
594 # for PSC Service Attachment.
595 &quot;trafficDuration&quot;: &quot;A String&quot;,
596 },
597 ],
598 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
599 # specified load balancer types.
600 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
601 # Pragma or Authorization headers. Up to 5 headers can be specified.
602 # The cache is bypassed for all cdnPolicy.cacheMode settings.
603 { # Bypass the cache when the specified request headers are present,
604 # e.g. Pragma or Authorization headers. Values are case insensitive.
605 # The presence of such a header overrides the cache_mode setting.
606 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
607 # Values are case-insensitive.
608 },
609 ],
610 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
611 # CDN.
612 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
613 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
614 &quot;A String&quot;,
615 ],
616 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
617 # The name=value pair will be used in the cache key Cloud CDN generates.
618 &quot;A String&quot;,
619 ],
620 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
621 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
622 # query_string_whitelist and query_string_blacklist. If neither is set, the
623 # entire query string will be included. If false, the query string will be
624 # excluded from the cache key entirely.
625 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
626 # parameters will be included. Either specify query_string_whitelist or
627 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
628 # not treated as delimiters.
629 &quot;A String&quot;,
630 ],
631 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
632 # parameters will be excluded. Either specify query_string_whitelist or
633 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
634 # not treated as delimiters.
635 &quot;A String&quot;,
636 ],
637 },
638 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
639 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
640 # headers to cache content. Responses without these headers will not be
641 # cached at Google&#x27;s edge, and will require a full trip to the origin on
642 # every request, potentially impacting performance and increasing load on
643 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
644 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
645 # Warning: this may result in Cloud CDN caching private,
646 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
647 # including common image formats, media (video and audio), and web assets
648 # (JavaScript and CSS). Requests and responses that are marked as
649 # uncacheable, as well as dynamic content (including HTML), will not be
650 # cached.
651 #
652 # If no value is provided for cdnPolicy.cacheMode, it defaults
653 # to CACHE_ALL_STATIC.
654 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
655 # used to clamp the max-age (or Expires) value sent to the client. With
656 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
657 # response max-age directive, along with a &quot;public&quot; directive. For
658 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
659 # from the origin (if specified), or else sets the response max-age
660 # directive to the lesser of the client_ttl and default_ttl, and also
661 # ensures a &quot;public&quot; cache-control directive is present.
662 # If a client TTL is not specified, a default value (1 hour) will be used.
663 # The maximum allowed value is 31,622,400s (1 year).
664 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
665 # responses that do not have an existing valid TTL (max-age or s-maxage).
666 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
667 # The value of defaultTTL cannot be set to a value greater than that of
668 # maxTTL, but can be equal.
669 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
670 # will overwrite the TTL set in all responses. The maximum allowed value is
671 # 31,622,400s (1 year), noting that infrequently accessed objects may be
672 # evicted from the cache before the defined TTL.
673 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
674 # origin.
675 # Cache directives that attempt to set a max-age or s-maxage higher than
676 # this, or an Expires header more than maxTTL seconds in the future will
677 # be capped at the value of maxTTL, as if it were the value of an
678 # s-maxage Cache-Control directive.
679 # Headers sent to the client will not be modified.
680 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
681 # The maximum allowed value is 31,622,400s (1 year), noting that
682 # infrequently accessed objects may be evicted from the cache before
683 # the defined TTL.
684 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
685 # to apply fine-grained caching for common errors or redirects.
686 # This can reduce the load on your origin and improve end-user
687 # experience by reducing response latency.
688 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
689 # negative caching applies to responses with the specified response code
690 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
691 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
692 # to all responses with the specified response code, and override any
693 # caching headers.
694 # By default, Cloud CDN will apply the following default TTLs to these
695 # status codes:
696 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
697 # HTTP 404 (Not Found), 410 (Gone),
698 # 451 (Unavailable For Legal Reasons): 120s
699 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
700 # These defaults can be overridden in negative_caching_policy.
701 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
702 # negative_caching must be enabled to configure negative_caching_policy.
703 # Omitting the policy and leaving negative_caching enabled will use
704 # Cloud CDN&#x27;s default cache TTLs.
705 # Note that when specifying an explicit negative_caching_policy, you
706 # should take care to specify a cache TTL for all response codes
707 # that you wish to cache. Cloud CDN will not apply any default
708 # negative caching when a policy exists.
709 { # Specify CDN TTLs for response error codes.
710 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
711 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
712 # specified as values, and you cannot specify a status code more than
713 # once.
714 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
715 # corresponding status code.
716 # The maximum allowed value is 1800s (30 minutes), noting that
717 # infrequently accessed objects may be evicted from the cache before the
718 # defined TTL.
719 },
720 ],
721 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
722 # requests into a small number of requests to the origin.
723 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
724 # content with the origin, or when an error is encountered when refreshing
725 # the cache.
726 # This setting defines the default &quot;max-stale&quot; duration for any cached
727 # responses that do not specify a max-stale directive. Stale responses that
728 # exceed the TTL configured here will not be served. The default limit
729 # (max-stale) is 86400s (1 day), which will allow stale content to be
730 # served up to this limit beyond the max-age (or s-maxage) of a cached
731 # response.
732 # The maximum allowed value is 604800 (1 week).
733 # Set this to zero (0) to disable serve-while-stale.
734 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
735 # considered fresh. After this time period, the response will be
736 # revalidated before being served. Defaults to 1hr (3600s). When serving
737 # responses to signed URL requests, Cloud CDN will internally behave as
738 # though all responses from this backend had a &quot;Cache-Control:
739 # public, max-age=[TTL]&quot; header, regardless of any existing
740 # Cache-Control header. The actual headers served in responses will not be
741 # altered.
742 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
743 &quot;A String&quot;,
744 ],
745 },
746 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
747 # backend service.
748 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
749 # as a count of seconds and fractions of seconds at nanosecond
750 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
751 # or &quot;month&quot;. Range is approximately 10,000 years.
752 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
753 # Durations less than one second are represented with a 0
754 # `seconds` field and a positive `nanos` field. Must be from 0
755 # to 999,999,999 inclusive.
756 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
757 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
758 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
759 },
760 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
761 # there is no limit.
762 #
763 # Not supported when the backend service is referenced by a URL map that is
764 # bound to target gRPC proxy that has validateForProxyless field set to true.
765 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
766 # not specified, there is no limit.
767 #
768 # Not supported when the backend service is referenced by a URL map that is
769 # bound to target gRPC proxy that has validateForProxyless field set to true.
770 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
771 # service. If not specified, there is no limit.
772 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
773 # This parameter is respected by both the HTTP/1.1 and HTTP/2
774 # implementations. If not specified, there is no limit. Setting this
775 # parameter to 1 will effectively disable keep alive.
776 #
777 # Not supported when the backend service is referenced by a URL map that is
778 # bound to target gRPC proxy that has validateForProxyless field set to true.
779 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
780 # not specified, the default is 1.
781 #
782 # Not supported when the backend service is referenced by a URL map that is
783 # bound to target gRPC proxy that has validateForProxyless field set to true.
784 },
785 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
786 # the client&#x27;s Accept-Encoding header.
787 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
788 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
789 # instance. For supported load balancers and protocols, as described inEnabling
790 # connection draining.
791 },
792 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
793 # tracking policy settings are only available for external passthrough
794 # Network Load Balancers and internal passthrough Network Load Balancers.
795 #
796 # connectionTrackingPolicy cannot be specified with haPolicy.
797 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
798 # value is DEFAULT_FOR_PROTOCOL.
799 #
800 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
801 # persist on unhealthy backends only for connection-oriented protocols
802 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
803 # Affinity is configured for 5-tuple. They do not persist forUDP.
804 #
805 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
806 # the existing connections on the unhealthy backend are never persisted on
807 # the unhealthy backend. They are always diverted to newly selected healthy
808 # backends (unless all backends are unhealthy).
809 #
810 # If set to ALWAYS_PERSIST, existing connections always
811 # persist on unhealthy backends regardless of protocol and session
812 # affinity. It is generally not recommended to use this mode overriding the
813 # default.
814 #
815 # For more details, see [Connection Persistence for Network Load
816 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
817 # and [Connection Persistence for Internal TCP/UDP Load
818 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
819 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
820 # Balancers. This option is not available publicly.
821 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
822 # matching traffic (in seconds).
823 #
824 # For internal passthrough Network Load Balancers:
825 #
826 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
827 # - It can be set only if Connection Tracking is less than 5-tuple
828 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
829 # Mode is PER_SESSION).
830 #
831 #
832 #
833 # For external passthrough Network Load Balancers the default is 60
834 # seconds. This option is not available publicly.
835 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
836 # options:
837 #
838 # - PER_CONNECTION: This is the default mode. The Connection
839 # Tracking is performed as per the Connection Key (default Hash Method) for
840 # the specific protocol.
841 # - PER_SESSION: The Connection Tracking is performed as per
842 # the configured Session Affinity. It matches the configured Session
843 # Affinity.
844 #
845 #
846 #
847 # For more details, see [Tracking Mode for Network Load
848 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
849 # and [Tracking Mode for Internal TCP/UDP Load
850 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
851 },
852 &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
853 # affinity based on HTTP headers, cookies or other properties. This load
854 # balancing policy is applicable only for HTTP connections. The affinity to a
855 # particular destination host will be lost when one or more hosts are
856 # added/removed from the destination service. This field specifies parameters
857 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
858 #
859 # This field is applicable to either:
860 #
861 # - A regional backend service with the service protocol set to HTTP,
862 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
863 # INTERNAL_MANAGED.
864 # - A global backend service with the
865 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
866 &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
867 # be used as the hash key for the consistent hash load balancer. If the
868 # cookie is not present, it will be generated. This field is applicable if
869 # the sessionAffinity is set to HTTP_COOKIE.
870 #
871 # Not supported when the backend service is referenced by a URL map that is
872 # bound to target gRPC proxy that has validateForProxyless field set to true.
873 # for load balancing policies that use a consistent hash.
874 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
875 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
876 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
877 # as a count of seconds and fractions of seconds at nanosecond
878 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
879 # or &quot;month&quot;. Range is approximately 10,000 years.
880 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
881 # Durations less than one second are represented with a 0
882 # `seconds` field and a positive `nanos` field. Must be from 0
883 # to 999,999,999 inclusive.
884 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
885 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
886 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
887 },
888 },
889 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
890 # applicable if the sessionAffinity is set toHEADER_FIELD.
891 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
892 # 1024. Larger ring sizes result in more granular load distributions. If the
893 # number of hosts in the load balancing pool is larger than the ring size,
894 # each host will be assigned a single virtual node.
895 },
896 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
897 # text format.
898 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
899 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
900 # locality_lb_policy.
901 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
902 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
903 # long and match the regular expression
904 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
905 # first character must be a lowercase letter, and all following
906 # characters must be a dash, period, underscore, lowercase letter, or
907 # digit, except the last character, which cannot be a dash, period, or
908 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
909 # field can only be used for a global or regional backend service with the
910 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
911 },
912 ],
913 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
914 # custom
915 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
916 &quot;A String&quot;,
917 ],
918 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
919 # custom
920 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
921 &quot;A String&quot;,
922 ],
923 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
924 # create the resource.
925 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
926 # backend service with dynamic forwarding feature which together with Service
927 # Extension allows customized and complex routing logic.
928 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
929 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
930 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
931 },
932 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
933 # service. Some ranges are restricted: Restricted
934 # ranges.
935 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
936 },
937 },
938 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
939 # this backend service.
940 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
941 # global external Application Load Balancer.
942 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
943 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
944 #
945 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
946 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
947 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
948 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
949 # externalManagedMigrationTestingPercentage.
950 #
951 # Rolling back a migration requires the states to be set in reverse order. So
952 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
953 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
954 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
955 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
956 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
957 # external Application Load Balancer.
958 #
959 # The value of this field must be in the range [0, 100].
960 #
961 # Session affinity options will slightly affect this routing behavior, for
962 # more details, see:Session
963 # Affinity.
964 #
965 # This value can only be set if the loadBalancingScheme in the BackendService
966 # is set to EXTERNAL (when using the classic Application Load Balancer) and
967 # the migration state is TEST_BY_PERCENTAGE.
968 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
969 # as a backup (failover) backend.
970 # For load balancers that have configurable failover:
971 # [Internal passthrough Network Load
972 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
973 # and [external passthrough Network Load
974 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
975 #
976 # failoverPolicy cannot be specified with haPolicy.
977 # failover:
978 # [Internal passthrough Network Load
979 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
980 # and [external passthrough
981 # Network Load
982 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
983 # On failover or failback, this field indicates whether connection draining
984 # will be honored. Google Cloud has a fixed connection draining timeout of
985 # 10 minutes. A setting of true terminates existing TCP
986 # connections to the active pool during failover and failback, immediately
987 # draining traffic. A setting of false allows existing TCP
988 # connections to persist, even on VMs no longer in the active pool, for up
989 # to the duration of the connection draining timeout (10 minutes).
990 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
991 #
992 # The default is false.
993 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
994 # load balancer are dropped when all primary and all backup backend VMs are
995 # unhealthy.If set to false, connections are distributed
996 # among all primary VMs when all primary and all backup backend VMs are
997 # unhealthy.
998 # For load balancers that have configurable
999 # failover:
1000 # [Internal passthrough
1001 # Network Load
1002 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1003 # and [external passthrough
1004 # Network Load
1005 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1006 # The default is false.
1007 &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
1008 # failover when the number of healthy primary VMs equals zero.
1009 # For all other values, the load balancer performs a failover when the
1010 # total number of healthy primary VMs is less than this ratio.
1011 # For load balancers that have configurable
1012 # failover:
1013 # [Internal TCP/UDP Load
1014 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1015 # and [external TCP/UDP Load
1016 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1017 },
1018 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1019 # This field is used in optimistic locking. This field will be ignored when
1020 # inserting a BackendService. An up-to-date fingerprint must be provided in
1021 # order to update the BackendService, otherwise the request will
1022 # fail with error 412 conditionNotMet.
1023 #
1024 # To see the latest fingerprint, make a get() request to
1025 # retrieve a BackendService.
1026 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
1027 # Protocol Forwarding.
1028 #
1029 # The backends of this regional backend service must only specify zonal
1030 # network endpoint groups (NEGs) of type GCE_VM_IP.
1031 #
1032 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
1033 # regional backend service must set the network field. All zonal NEGs must
1034 # belong to the same network. However, individual NEGs can
1035 # belong to different subnetworks of that network.
1036 #
1037 # When haPolicy is specified, the set of attached network endpoints across
1038 # all backends comprise an High Availability domain from which one endpoint
1039 # is selected as the active endpoint (the leader) that receives all
1040 # traffic.
1041 #
1042 # haPolicy can be added only at backend service creation time. Once set up,
1043 # it cannot be deleted.
1044 #
1045 # Note that haPolicy is not for load balancing, and therefore cannot be
1046 # specified with sessionAffinity, connectionTrackingPolicy, and
1047 # failoverPolicy.
1048 #
1049 # haPolicy requires customers to be responsible for tracking backend
1050 # endpoint health and electing a leader among the healthy endpoints.
1051 # Therefore, haPolicy cannot be specified with healthChecks.
1052 #
1053 # haPolicy can only be specified for External Passthrough Network Load
1054 # Balancers and Internal Passthrough Network Load Balancers.
1055 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
1056 # achieve it.
1057 #
1058 # Supported values are:
1059 #
1060 # - DISABLED: Fast IP Move is disabled. You can only use the
1061 # haPolicy.leader API to update the leader.
1062 # - &gt;GARP_RA: Provides a method to very quickly define a new network
1063 # endpoint as the leader. This method is faster than updating the leader
1064 # using the haPolicy.leader API. Fast IP move works as follows: The VM
1065 # hosting the network endpoint that should become the new leader sends
1066 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
1067 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
1068 # temporarily associates the forwarding rule IP address with that VM, and
1069 # both new and in-flight packets are quickly delivered to that VM.
1070 #
1071 #
1072 #
1073 # Note the important properties of the Fast IP Move functionality:
1074 #
1075 # - The GARP/RA-initiated re-routing stays active for approximately 20
1076 # minutes. After triggering fast failover, you must also
1077 # appropriately set the haPolicy.leader.
1078 # - The new leader instance should continue to send GARP/RA packets
1079 # periodically every 10 seconds until at least 10 minutes after updating
1080 # the haPolicy.leader (but stop immediately if it is no longer the leader).
1081 # - After triggering a fast failover, we recommend that you wait at least
1082 # 3 seconds before sending another GARP/RA packet from a different VM
1083 # instance to avoid race conditions.
1084 # - Don&#x27;t send GARP/RA packets from different VM
1085 # instances at the same time. If multiple instances continue to send
1086 # GARP/RA packets, traffic might be routed to different destinations in an
1087 # alternating order. This condition ceases when a single instance
1088 # issues a GARP/RA packet.
1089 # - The GARP/RA request always takes priority over the leader API.
1090 # Using the haPolicy.leader API to change the leader to a different
1091 # instance will have no effect until the GARP/RA request becomes
1092 # inactive.
1093 # - The GARP/RA packets should follow the GARP/RA
1094 # Packet Specifications..
1095 # - When multiple forwarding rules refer to a regional backend service,
1096 # you need only send a GARP or RA packet for a single forwarding rule
1097 # virtual IP. The virtual IPs for all forwarding rules targeting the same
1098 # backend service will also be moved to the sender of the GARP or RA
1099 # packet.
1100 #
1101 #
1102 #
1103 # The following are the Fast IP Move limitations (that is, when fastIPMove
1104 # is not DISABLED):
1105 #
1106 # - Multiple forwarding rules cannot use the same IP address if one of
1107 # them refers to a regional backend service with fastIPMove.
1108 # - The regional backend service must set the network field, and all
1109 # NEGs must belong to that network. However, individual
1110 # NEGs can belong to different subnetworks of that network.
1111 # - The maximum number of network endpoints across all backends of a
1112 # backend service with fastIPMove is 32.
1113 # - The maximum number of backend services with fastIPMove that can have
1114 # the same network endpoint attached to one of its backends is 64.
1115 # - The maximum number of backend services with fastIPMove in a VPC in a
1116 # region is 64.
1117 # - The network endpoints that are attached to a backend of a backend
1118 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
1119 # - Traffic directed to the leader by a static route next hop will not be
1120 # redirected to a new leader by fast failover. Such traffic will only be
1121 # redirected once an haPolicy.leader update has taken effect. Only traffic
1122 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
1123 # fast failover.
1124 #
1125 #
1126 # haPolicy.fastIPMove can be set only at backend service creation time.
1127 # Once set, it cannot be updated.
1128 #
1129 # By default, fastIpMove is set to DISABLED.
1130 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
1131 # this service as the active endpoint (the leader) that receives all
1132 # traffic.
1133 #
1134 # When the leader changes, there is no connection draining to persist
1135 # existing connections on the old leader.
1136 #
1137 # You are responsible for selecting a suitable endpoint as the
1138 # leader. For example, preferring a healthy endpoint over unhealthy ones.
1139 # Note that this service does not track backend endpoint health, and
1140 # selects the configured leader unconditionally.
1141 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
1142 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
1143 # that the leader is attached to.
1144 #
1145 # The leader&#x27;s backendGroup must already be specified as a backend of
1146 # this backend service. Removing a backend that is designated as the
1147 # leader&#x27;s backendGroup is not permitted.
1148 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
1149 # designated as the leader.
1150 #
1151 # This network endpoint cannot be detached from the NEG specified in
1152 # the haPolicy.leader.backendGroup until the leader is updated with
1153 # another network endpoint, or the leader is removed from the haPolicy.
1154 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
1155 # instance must already be attached to the NEG specified in the
1156 # haPolicy.leader.backendGroup.
1157 #
1158 # The name must be 1-63 characters long, and comply with RFC1035.
1159 # Authorization requires the following IAM permission on the
1160 # specified resource instance: compute.instances.use
1161 },
1162 },
1163 },
1164 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
1165 # httpsHealthChecks (legacy) resource for health checking this backend
1166 # service. Not all backend services support legacy health checks. See
1167 # Load balancer guide. Currently, at most one health check can be
1168 # specified for each backend service. Backend services with
1169 # instance group or zonal NEG backends must have a health check unless
1170 # haPolicy is specified. Backend services with internet or serverless NEG
1171 # backends must not have a health check.
1172 #
1173 # healthChecks[] cannot be specified with haPolicy.
1174 &quot;A String&quot;,
1175 ],
1176 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
1177 # Not available for internal passthrough Network Load Balancers and external
1178 # passthrough Network Load Balancers.
1179 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
1180 # incoming requests.
1181 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
1182 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
1183 # for IAP.
1184 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
1185 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
1186 # Optional - If not provided, the name will be autogenerated by the
1187 # backend.
1188 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
1189 },
1190 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
1191 # For security reasons, this value cannot be retrieved via the API.
1192 # Instead, the SHA-256 hash of the value is returned in the
1193 # oauth2ClientSecretSha256 field.
1194 #
1195 # @InputOnly
1196 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
1197 },
1198 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1199 # defined by the server.
1200 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
1201 # from the client to the backend for proxyless gRPC).
1202 # The possible values are:
1203 #
1204 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
1205 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1206 # Group), regardless of traffic from the client to the proxy. Only IPv4
1207 # health checks are used to check the health of the backends. This is the
1208 # default setting.
1209 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
1210 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
1211 # address).
1212 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
1213 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1214 # Group), regardless of traffic from the client to the proxy. Only IPv6
1215 # health checks are used to check the health of the backends.
1216 #
1217 #
1218 #
1219 # This field is applicable to either:
1220 #
1221 # - Advanced global external Application Load Balancer (load balancing
1222 # scheme EXTERNAL_MANAGED),
1223 # - Regional external Application Load
1224 # Balancer,
1225 # - Internal proxy Network Load Balancer (load balancing
1226 # scheme INTERNAL_MANAGED),
1227 # - Regional internal Application Load
1228 # Balancer (load balancing scheme INTERNAL_MANAGED),
1229 # - Traffic
1230 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
1231 # INTERNAL_SELF_MANAGED).
1232 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
1233 # for backend services.
1234 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
1235 # created for one type of load balancer cannot be used with another.
1236 # For more information, refer toChoosing
1237 # a load balancer.
1238 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
1239 # preference. When you use localityLbPolicies, you must set at least one
1240 # value for either the localityLbPolicies[].policy or the
1241 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
1242 # value set in the localityLbPolicy field.
1243 #
1244 # For an example of how to use this field, seeDefine
1245 # a list of preferred policies.
1246 #
1247 # Caution: This field and its children are intended for use in a service mesh
1248 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
1249 # that have this configuration.
1250 { # Container for either a built-in LB policy supported by gRPC or Envoy or
1251 # a custom one implemented by the end user.
1252 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
1253 # deployed with the client.
1254 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
1255 # by a locally installed custom policy implementation.
1256 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
1257 #
1258 # The value should match the name of a custom implementation registered
1259 # on the gRPC clients. It should follow protocol buffer message naming
1260 # conventions and include the full path (for example,
1261 # myorg.CustomLbPolicy). The maximum length is 256 characters.
1262 #
1263 # Do not specify the same custom policy more than once for a
1264 # backend. If you do, the configuration is rejected.
1265 #
1266 # For an example of how to use this field, seeUse
1267 # a custom policy.
1268 },
1269 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
1270 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
1271 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
1272 # about these values, see the description of localityLbPolicy.
1273 #
1274 # Do not specify the same policy more than once for a
1275 # backend. If you do, the configuration is rejected.
1276 },
1277 },
1278 ],
1279 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
1280 # possible values are:
1281 #
1282 # - ROUND_ROBIN: This is a simple policy in which each healthy
1283 # backend is selected in round robin order. This is the default.
1284 # - LEAST_REQUEST: An O(1) algorithm which
1285 # selects two random healthy hosts and picks the host which has fewer active
1286 # requests.
1287 # - RING_HASH: The ring/modulo hash load balancer implements
1288 # consistent hashing to backends. The algorithm has the property that the
1289 # addition/removal of a host from a set of N hosts only affects 1/N of the
1290 # requests.
1291 # - RANDOM: The load balancer selects a random healthy
1292 # host.
1293 # - ORIGINAL_DESTINATION: Backend host is selected
1294 # based on the client connection metadata, i.e., connections are opened to
1295 # the same address as the destination address of the incoming connection
1296 # before the connection was redirected to the load balancer.
1297 # - MAGLEV: used as a drop in replacement for the ring hash
1298 # load balancer. Maglev is not as stable as ring hash but has faster table
1299 # lookup build times and host selection times. For more information about
1300 # Maglev, see Maglev:
1301 # A Fast and Reliable Software Network Load Balancer.
1302 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
1303 # Load Balancing using weights computed from Backend reported Custom Metrics.
1304 # If set, the Backend Service responses are expected to contain non-standard
1305 # HTTP response header field Endpoint-Load-Metrics. The reported
1306 # metrics to use for computing the weights are specified via thecustomMetrics field.
1307 #
1308 # This field is applicable to either:
1309 # - A regional backend service with the service protocol set to HTTP,
1310 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
1311 # INTERNAL_MANAGED.
1312 # - A global backend service with the
1313 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
1314 # EXTERNAL_MANAGED.
1315 #
1316 #
1317 # If sessionAffinity is not configured—that is, if session
1318 # affinity remains at the default value of NONE—then the
1319 # default value for localityLbPolicy
1320 # is ROUND_ROBIN. If session affinity is set to a value other
1321 # than NONE,
1322 # then the default value for localityLbPolicy isMAGLEV.
1323 #
1324 # Only ROUND_ROBIN and RING_HASH are supported
1325 # when the backend service is referenced by a URL map that is bound to
1326 # target gRPC proxy that has validateForProxyless field set to true.
1327 #
1328 # localityLbPolicy cannot be specified with haPolicy.
1329 &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
1330 # by this backend service. If logging is enabled, logs will be exported to
1331 # Stackdriver.
1332 # backend service.
1333 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
1334 # traffic served by this backend service. The default value is false.
1335 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
1336 { # Determines which HTTP headers will be logged to Stackdriver.
1337 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1338 },
1339 ],
1340 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
1341 { # Determines which HTTP headers will be logged to Stackdriver.
1342 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1343 },
1344 ],
1345 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
1346 # This field can only be specified if logging is enabled for this backend
1347 # service. Configures whether all, none or a subset of optional fields
1348 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1349 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1350 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
1351 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
1352 # of optional fields you want to include in the logs. For example:
1353 # serverInstance, serverGkeDetails.cluster,
1354 # serverGkeDetails.pod.podNamespace
1355 &quot;A String&quot;,
1356 ],
1357 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
1358 # service. Configures whether all, none or a subset of optional fields
1359 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1360 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1361 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
1362 # service. The value of the field must be in [0, 1]. This configures the
1363 # sampling rate of requests to the load balancer where 1.0 means all logged
1364 # requests are reported and 0.0 means no logged requests are reported. The
1365 # default value is 1.0.
1366 },
1367 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
1368 # service. Duration is computed from the beginning of the stream until the
1369 # response has been completely processed, including all retries. A stream
1370 # that does not complete in this duration is closed.
1371 #
1372 # If not specified, there will be no timeout limit, i.e. the maximum
1373 # duration is infinite.
1374 #
1375 # This value can be overridden in the PathMatcher configuration of the
1376 # UrlMap that references this backend service.
1377 #
1378 # This field is only allowed when the loadBalancingScheme of
1379 # the backend service is INTERNAL_SELF_MANAGED.
1380 # as a count of seconds and fractions of seconds at nanosecond
1381 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1382 # or &quot;month&quot;. Range is approximately 10,000 years.
1383 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1384 # Durations less than one second are represented with a 0
1385 # `seconds` field and a positive `nanos` field. Must be from 0
1386 # to 999,999,999 inclusive.
1387 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1388 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1389 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1390 },
1391 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
1392 # controller and read by the backend RCTH
1393 &quot;a_key&quot;: &quot;A String&quot;,
1394 },
1395 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1396 # The name must be 1-63 characters long, and comply withRFC1035.
1397 # Specifically, the name must be 1-63 characters long and match the regular
1398 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1399 # character must be a lowercase letter, and all following characters must
1400 # be a dash, lowercase letter, or digit, except the last character, which
1401 # cannot be a dash.
1402 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
1403 #
1404 # This field must be set for Internal Passthrough Network Load Balancers when
1405 # the haPolicy is enabled, and for External Passthrough Network Load
1406 # Balancers when the haPolicy fastIpMove is enabled.
1407 #
1408 # 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.
1409 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
1410 # Load Balancers.
1411 #
1412 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
1413 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
1414 # endpoints in the local zone.
1415 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
1416 # possible values are:
1417 #
1418 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
1419 # is disabled. The load balancer distributes new connections to all
1420 # healthy backend endpoints across all zones.
1421 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
1422 # enabled. The load balancer distributes new connections to all healthy
1423 # backend endpoints in the local zone only. If there are no healthy
1424 # backend endpoints in the local zone, the load balancer distributes
1425 # new connections to all backend endpoints in the local zone.
1426 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
1427 # enabled. The load balancer distributes new connections to all healthy
1428 # backend endpoints in the local zone only. If there aren&#x27;t enough
1429 # healthy backend endpoints in the local zone, the load balancer
1430 # distributes new connections to all healthy backend endpoints across all
1431 # zones.
1432 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
1433 # of healthy backend endpoints in a zone to the count of backend
1434 # endpoints in that same zone is equal to or above this threshold, the
1435 # load balancer distributes new connections to all healthy endpoints in
1436 # the local zone only. When the ratio of the count of healthy backend
1437 # endpoints in a zone to the count of backend endpoints in that same
1438 # zone is below this threshold, the load balancer distributes all new
1439 # connections to all healthy endpoints across all zones.
1440 },
1441 },
1442 &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.
1443 # the backend service.
1444 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
1445 # service.
1446 },
1447 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
1448 # load balancing pool of each individual proxy instance that processes the
1449 # traffic for the given backend service. If not set, this feature is
1450 # considered disabled.
1451 #
1452 # Results of the outlier detection algorithm (ejection of endpoints from the
1453 # load balancing pool and returning them back to the pool) are executed
1454 # independently by each proxy instance of the load balancer. In most cases,
1455 # more than one proxy instance handles the traffic received by a backend
1456 # service. Thus, it is possible that an unhealthy endpoint is detected and
1457 # ejected by only some of the proxies, and while this happens, other proxies
1458 # may continue to send requests to the same unhealthy endpoint until they
1459 # detect and eject the unhealthy endpoint.
1460 #
1461 # Applicable backend endpoints can be:
1462 #
1463 # - VM instances in an Instance Group
1464 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
1465 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
1466 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
1467 # Functions Services
1468 # - Private Service Connect NEGs, that resolve to
1469 # Google-managed regional API endpoints or managed services published using
1470 # Private Service Connect
1471 #
1472 #
1473 #
1474 # Applicable backend service types can be:
1475 #
1476 # - A global backend service with the loadBalancingScheme set to
1477 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
1478 # - A regional backend
1479 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
1480 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
1481 # supported for Serverless NEGs.
1482 #
1483 #
1484 #
1485 # Not supported when the backend service is referenced by a URL map that is
1486 # bound to target gRPC proxy that has validateForProxyless field set to true.
1487 # pool for the backend service.
1488 &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
1489 # or 30s.
1490 #
1491 # After a backend endpoint is returned back to the load balancing pool, it
1492 # can be ejected again in another ejection analysis. Thus, the total ejection
1493 # time is equal to the base ejection time multiplied by the number of times
1494 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
1495 # as a count of seconds and fractions of seconds at nanosecond
1496 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1497 # or &quot;month&quot;. Range is approximately 10,000 years.
1498 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1499 # Durations less than one second are represented with a 0
1500 # `seconds` field and a positive `nanos` field. Must be from 0
1501 # to 999,999,999 inclusive.
1502 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1503 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1504 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1505 },
1506 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
1507 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
1508 # return code qualifies as an error. Defaults to 5.
1509 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
1510 # connection errors that are mapped to one of those status codes) before a
1511 # consecutive gateway failure ejection occurs. Defaults to 3.
1512 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1513 # outlier status is detected through consecutive 5xx. This setting can be
1514 # used to disable ejection or to ramp it up slowly. Defaults to 0.
1515 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1516 # outlier status is detected through consecutive gateway failures. This
1517 # setting can be used to disable ejection or to ramp it up slowly. Defaults
1518 # to 100.
1519 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1520 # outlier status is detected through success rate statistics. This setting
1521 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
1522 #
1523 # Not supported when the backend service uses Serverless NEG.
1524 &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
1525 # ejections and backend endpoints being returned to service. The interval is
1526 # equal to the number of seconds as defined in
1527 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
1528 # in outlierDetection.interval.nanos. Defaults to 1 second.
1529 # as a count of seconds and fractions of seconds at nanosecond
1530 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1531 # or &quot;month&quot;. Range is approximately 10,000 years.
1532 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1533 # Durations less than one second are represented with a 0
1534 # `seconds` field and a positive `nanos` field. Must be from 0
1535 # to 999,999,999 inclusive.
1536 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1537 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1538 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1539 },
1540 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
1541 # backend service that can be ejected if the ejection conditions are met.
1542 # Defaults to 50%.
1543 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
1544 # enough request volume to detect success rate outliers. If the number of
1545 # backend endpoints is fewer than this setting, outlier detection via success
1546 # rate statistics is not performed for any backend endpoint in the load
1547 # balancing pool. Defaults to 5.
1548 #
1549 # Not supported when the backend service uses Serverless NEG.
1550 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
1551 # (as defined by the interval duration above) to include this backend
1552 # endpoint in success rate based outlier detection. If the volume is lower
1553 # than this setting, outlier detection via success rate statistics is not
1554 # performed for that backend endpoint. Defaults to 100.
1555 #
1556 # Not supported when the backend service uses Serverless NEG.
1557 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
1558 # outlier ejection. The ejection threshold is the difference between the mean
1559 # success rate, and the product of this factor and the standard deviation of
1560 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
1561 # is divided by a thousand to get a double. That is, if the desired factor
1562 # is 1.9, the runtime value should be 1900. Defaults to 1900.
1563 #
1564 # Not supported when the backend service uses Serverless NEG.
1565 },
1566 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1567 # as part of resource payload.
1568 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1569 # Tag keys and values have the same definition as resource
1570 # manager tags. The field is allowed for INSERT
1571 # only. The keys/values to set on the resource should be specified in
1572 # either ID { : } or Namespaced format
1573 # { : }.
1574 # For example the following are valid inputs:
1575 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1576 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1577 # Note:
1578 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1579 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1580 &quot;a_key&quot;: &quot;A String&quot;,
1581 },
1582 },
1583 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
1584 # the backend. The default value is 80.
1585 # For internal passthrough Network Load Balancers and external passthrough
1586 # Network Load Balancers, omit port.
1587 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
1588 # communication to the backend VMs in that group. The
1589 # named port must be [defined on each backend instance
1590 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
1591 # This parameter has no meaning if the backends are NEGs. For internal
1592 # passthrough Network Load Balancers and external passthrough Network Load
1593 # Balancers, omit port_name.
1594 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
1595 # with backends.
1596 #
1597 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
1598 # depending on the chosen load balancer or Traffic Director configuration.
1599 # Refer to the documentation for the load balancers or for Traffic Director
1600 # for more information.
1601 #
1602 # Must be set to GRPC when the backend service is referenced by a URL map
1603 # that is bound to target gRPC proxy.
1604 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
1605 # resides. This field is not applicable to global backend services.
1606 # You must specify this field as part of the HTTP request URL. It is
1607 # not settable as a field in the request body.
1608 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1609 # backend service.
1610 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
1611 # service. This field is applicable to a global backend service with the
1612 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
1613 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
1614 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
1615 # be accepted on backends, and if authenticated, which method/certificate
1616 # will set the request principal.
1617 # request principal.
1618 # The authentication settings for the backend service.
1619 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
1620 # Similar to peers, these will be evaluated in order the first valid one
1621 # will be used to set origin identity. If none of these methods pass, the
1622 # request will be rejected with authentication failed error (401). Leave the
1623 # list empty if origin authentication is not required.
1624 { # [Deprecated] Configuration for the origin authentication method.
1625 # Configuration for the origin authentication method.
1626 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
1627 # JWT configuration for origin authentication.
1628 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
1629 # will be accepted if audiences is empty.
1630 # Examples: bookstore_android.apps.googleusercontent.com,
1631 # bookstore_web.apps.googleusercontent.com
1632 &quot;A String&quot;,
1633 ],
1634 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
1635 # email address.
1636 # Examples: https://securetoken.google.com,
1637 # [email protected]
1638 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
1639 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
1640 # request. If no explicit location is specified, the following default
1641 # locations are tried in order:
1642 #
1643 # 1. The Authorization header using the Bearer schema. See `here
1644 # `_. Example:
1645 #
1646 # Authorization: Bearer .
1647 #
1648 # 2. `access_token` query parameter. See `this
1649 # `_
1650 #
1651 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
1652 # from the locations its issuer specified or from the default locations.
1653 #
1654 # This field is set if JWT is sent in a request header. This field specifies
1655 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
1656 # header format will be x-goog-iap-jwt-assertion: .
1657 { # [Deprecated] This message specifies a header location to extract JWT token.
1658 # This message specifies a header location to extract JWT token.
1659 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
1660 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
1661 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
1662 # with a space at the end.
1663 },
1664 ],
1665 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
1666 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
1667 # JWT format in the query parameter is /path?jwt_token=.
1668 &quot;A String&quot;,
1669 ],
1670 },
1671 },
1672 ],
1673 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
1674 # They will be evaluated in order the first valid one will be used to set
1675 # peer identity. If none of these methods pass, the request will be rejected
1676 # with authentication failed error (401). Leave the list empty if peer
1677 # authentication is not required.
1678 { # [Deprecated] Configuration for the peer authentication method.
1679 # Configuration for the peer authentication method.
1680 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
1681 # Configuration for the mutual Tls mode for peer authentication.
1682 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
1683 # field can be set to one of the following:
1684 # STRICT: Client certificate must be presented, connection is in TLS.
1685 # PERMISSIVE: Client certificate can be omitted, connection can be either
1686 # plaintext or TLS.
1687 },
1688 },
1689 ],
1690 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
1691 # Default value is USE_PEER. If peer (or origin) identity is not available,
1692 # either because peer/origin authentication is not defined, or failed,
1693 # principal will be left unset. In other words, binding rule does not affect
1694 # the decision to accept or reject request. This field can be set to one of
1695 # the following:
1696 # USE_PEER: Principal will be set to the identity from peer authentication.
1697 # USE_ORIGIN: Principal will be set to the identity from origin
1698 # authentication.
1699 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
1700 # identity information.
1701 # The TLS settings for the client or server.
1702 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
1703 # certificate.
1704 # Defines the mechanism to obtain the client or server certificate.
1705 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
1706 # applicable only if tlsCertificateSource is set to USE_PATH.
1707 # The paths to the mounted TLS Certificates and private key.
1708 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1709 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1710 },
1711 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
1712 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
1713 # is applicable only if tlsCertificateSource is set to USE_SDS.
1714 # The configuration to access the SDS server.
1715 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
1716 # gRPC config to access the SDS server.
1717 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
1718 # gRPC call credentials to access the SDS server.
1719 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
1720 # This field can be set to one of the following:
1721 #
1722 # - GCE_VM: The local GCE VM service account credentials are used to access
1723 # the SDS server.
1724 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
1725 # SDS server.
1726 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
1727 # FROM_PLUGIN.
1728 # Custom authenticator credentials.
1729 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
1730 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
1731 # plugin.
1732 },
1733 },
1734 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
1735 # gRPC channel credentials to access the SDS server.
1736 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
1737 # The paths to the mounted TLS Certificates and private key.
1738 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1739 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1740 },
1741 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
1742 # to one of the following:
1743 # CERTIFICATES: Use TLS certificates to access the SDS server.
1744 # GCE_VM: Use local GCE VM credentials to access the SDS server.
1745 },
1746 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
1747 },
1748 },
1749 },
1750 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
1751 # validate the client/server certificate. If omitted, the proxy will not
1752 # validate the server or client certificate.
1753 # certificate to validate the client/server certificate.
1754 # validate the client/server certificate.
1755 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
1756 # client or server certificate.
1757 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
1758 # is applicable only if tlsCertificateSource is set to USE_SDS.
1759 # The configuration to access the SDS server.
1760 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
1761 # gRPC config to access the SDS server.
1762 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
1763 # gRPC call credentials to access the SDS server.
1764 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
1765 # This field can be set to one of the following:
1766 #
1767 # - GCE_VM: The local GCE VM service account credentials are used to access
1768 # the SDS server.
1769 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
1770 # SDS server.
1771 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
1772 # FROM_PLUGIN.
1773 # Custom authenticator credentials.
1774 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
1775 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
1776 # plugin.
1777 },
1778 },
1779 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
1780 # gRPC channel credentials to access the SDS server.
1781 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
1782 # The paths to the mounted TLS Certificates and private key.
1783 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1784 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1785 },
1786 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
1787 # to one of the following:
1788 # CERTIFICATES: Use TLS certificates to access the SDS server.
1789 # GCE_VM: Use local GCE VM credentials to access the SDS server.
1790 },
1791 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
1792 },
1793 },
1794 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
1795 },
1796 },
1797 },
1798 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
1799 # (RBAC) config.
1800 # Authorization config defines the Role Based Access Control (RBAC) config.
1801 # method-level access control for a service.
1802 # control for a service.
1803 &quot;policies&quot;: [ # List of RbacPolicies.
1804 {
1805 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
1806 &quot;permissions&quot;: [ # The list of permissions.
1807 { # [Deprecated] All fields defined in a permission are ANDed.
1808 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
1809 { # Custom constraint that specifies a key and a list of allowed values for
1810 # Istio attributes.
1811 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
1812 &quot;values&quot;: [ # A list of allowed values.
1813 &quot;A String&quot;,
1814 ],
1815 },
1816 ],
1817 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
1818 # applies to. Exact match, prefix match, and suffix match are supported.
1819 &quot;A String&quot;,
1820 ],
1821 &quot;methods&quot;: [ # HTTP method.
1822 &quot;A String&quot;,
1823 ],
1824 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
1825 &quot;A String&quot;,
1826 ],
1827 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
1828 &quot;A String&quot;,
1829 ],
1830 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
1831 &quot;A String&quot;,
1832 ],
1833 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
1834 &quot;A String&quot;,
1835 ],
1836 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
1837 # Exact match, prefix match, and suffix match are supported.
1838 &quot;A String&quot;,
1839 ],
1840 &quot;ports&quot;: [ # Port names or numbers.
1841 &quot;A String&quot;,
1842 ],
1843 },
1844 ],
1845 &quot;principals&quot;: [ # The list of principals.
1846 { # [Deprecated] All fields defined in a principal are ANDed.
1847 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
1848 &quot;groups&quot;: [ # The groups the principal belongs to.
1849 # Exact match, prefix match, and suffix match are supported.
1850 &quot;A String&quot;,
1851 ],
1852 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
1853 &quot;A String&quot;,
1854 ],
1855 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
1856 &quot;A String&quot;,
1857 ],
1858 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
1859 &quot;A String&quot;,
1860 ],
1861 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
1862 &quot;A String&quot;,
1863 ],
1864 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
1865 &quot;A String&quot;,
1866 ],
1867 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
1868 &quot;A String&quot;,
1869 ],
1870 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
1871 # suffix match are supported for values. For example,
1872 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
1873 &quot;a_key&quot;: &quot;A String&quot;,
1874 },
1875 &quot;users&quot;: [ # The user names/IDs or service accounts.
1876 # Exact match, prefix match, and suffix match are supported.
1877 &quot;A String&quot;,
1878 ],
1879 },
1880 ],
1881 },
1882 ],
1883 },
1884 &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
1885 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
1886 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
1887 # private storage buckets that support Signature Version 4 for authentication.
1888 # The service name for generating the authentication header will always default
1889 # to &#x27;s3&#x27;.
1890 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
1891 # creating a backend that uses AWS v4 signature authentication, but will not
1892 # be returned as part of the configuration when queried with a REST API GET
1893 # request.
1894 #
1895 # @InputOnly
1896 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
1897 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
1898 # keep track of different iterations of your access key.
1899 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
1900 # the name of the region your cloud uses to host your origin. For example,
1901 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
1902 },
1903 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
1904 # that describes how clients should authenticate with this service&#x27;s
1905 # backends.
1906 #
1907 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
1908 # to INTERNAL_SELF_MANAGED.
1909 #
1910 # If left blank, communications are not encrypted.
1911 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
1912 # originating from the backend service.
1913 # the backend service.
1914 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
1915 # identity information. This field is only applicable when mode is set to
1916 # MUTUAL.
1917 # The TLS settings for the client or server.
1918 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
1919 # certificate.
1920 # Defines the mechanism to obtain the client or server certificate.
1921 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
1922 # applicable only if tlsCertificateSource is set to USE_PATH.
1923 # The paths to the mounted TLS Certificates and private key.
1924 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1925 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1926 },
1927 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
1928 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
1929 # is applicable only if tlsCertificateSource is set to USE_SDS.
1930 # The configuration to access the SDS server.
1931 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
1932 # gRPC config to access the SDS server.
1933 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
1934 # gRPC call credentials to access the SDS server.
1935 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
1936 # This field can be set to one of the following:
1937 #
1938 # - GCE_VM: The local GCE VM service account credentials are used to access
1939 # the SDS server.
1940 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
1941 # SDS server.
1942 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
1943 # FROM_PLUGIN.
1944 # Custom authenticator credentials.
1945 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
1946 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
1947 # plugin.
1948 },
1949 },
1950 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
1951 # gRPC channel credentials to access the SDS server.
1952 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
1953 # The paths to the mounted TLS Certificates and private key.
1954 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1955 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1956 },
1957 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
1958 # to one of the following:
1959 # CERTIFICATES: Use TLS certificates to access the SDS server.
1960 # GCE_VM: Use local GCE VM credentials to access the SDS server.
1961 },
1962 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
1963 },
1964 },
1965 },
1966 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
1967 # validate the client/server certificate. If omitted, the proxy will not
1968 # validate the server or client certificate.
1969 # certificate to validate the client/server certificate.
1970 # validate the client/server certificate.
1971 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
1972 # client or server certificate.
1973 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
1974 # is applicable only if tlsCertificateSource is set to USE_SDS.
1975 # The configuration to access the SDS server.
1976 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
1977 # gRPC config to access the SDS server.
1978 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
1979 # gRPC call credentials to access the SDS server.
1980 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
1981 # This field can be set to one of the following:
1982 #
1983 # - GCE_VM: The local GCE VM service account credentials are used to access
1984 # the SDS server.
1985 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
1986 # SDS server.
1987 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
1988 # FROM_PLUGIN.
1989 # Custom authenticator credentials.
1990 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
1991 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
1992 # plugin.
1993 },
1994 },
1995 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
1996 # gRPC channel credentials to access the SDS server.
1997 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
1998 # The paths to the mounted TLS Certificates and private key.
1999 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
2000 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
2001 },
2002 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
2003 # to one of the following:
2004 # CERTIFICATES: Use TLS certificates to access the SDS server.
2005 # GCE_VM: Use local GCE VM credentials to access the SDS server.
2006 },
2007 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
2008 },
2009 },
2010 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
2011 },
2012 },
2013 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
2014 # The value of this field determines how TLS is enforced. This can be set
2015 # to one of the following values: DISABLE: Do not setup a TLS connection to
2016 # the backends.
2017 # SIMPLE: Originate a TLS connection to the backends.
2018 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
2019 # client certificates for authentication.
2020 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
2021 # applicable only when mode is SIMPLE or MUTUAL.
2022 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
2023 # certificate.If specified,
2024 # the proxy will verify that the server certificate&#x27;s subject alt name
2025 # matches one of the specified values. This field is applicable only when
2026 # mode is SIMPLE or MUTUAL.
2027 &quot;A String&quot;,
2028 ],
2029 },
2030 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
2031 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
2032 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
2033 # specified values, the communication continues. Otherwise, it fails. This
2034 # additional check enables the client to verify that the server is authorized
2035 # to run the requested service.
2036 #
2037 # Note that the contents of the server
2038 # certificate&#x27;s subjectAltName field are configured by the
2039 # Public Key Infrastructure which provisions server identities.
2040 #
2041 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
2042 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
2043 # mode).
2044 &quot;A String&quot;,
2045 ],
2046 },
2047 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2048 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2049 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
2050 #
2051 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
2052 # If set, lists of backends and health checks must be both empty.
2053 &quot;A String&quot;,
2054 ],
2055 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
2056 #
2057 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
2058 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
2059 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
2060 #
2061 # Only NONE and HEADER_FIELD are supported
2062 # when the backend service is referenced by a URL map that is bound to
2063 # target gRPC proxy that has validateForProxyless field set to true.
2064 #
2065 # For more details, see:
2066 # [Session
2067 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
2068 #
2069 # sessionAffinity cannot be specified with haPolicy.
2070 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
2071 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
2072 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
2073 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
2074 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
2075 # as a count of seconds and fractions of seconds at nanosecond
2076 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2077 # or &quot;month&quot;. Range is approximately 10,000 years.
2078 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2079 # Durations less than one second are represented with a 0
2080 # `seconds` field and a positive `nanos` field. Must be from 0
2081 # to 999,999,999 inclusive.
2082 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2083 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2084 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2085 },
2086 },
2087 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
2088 # Currently this is applicable only for Internal TCP/UDP load balancing,
2089 # Internal HTTP(S) load balancing and Traffic Director.
2090 &quot;policy&quot;: &quot;A String&quot;,
2091 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
2092 # each service mesh client.
2093 #
2094 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
2095 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
2096 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
2097 # `INTERNAL_SELF_MANAGED`.
2098 #
2099 # `subset_size` is optional for Internal HTTP(S) load balancing
2100 # and required for Traffic Director.
2101 #
2102 # If you do not provide this value, Cloud Load Balancing will calculate it
2103 # dynamically to optimize the number of proxies/clients visible to each
2104 # backend and vice versa.
2105 #
2106 # Must be greater than 0. If `subset_size` is larger than the number of
2107 # backends/endpoints, then subsetting is disabled.
2108 },
2109 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
2110 # type of load balancer. For more information see,
2111 # Backend service settings.
2112 # The default is 30 seconds.
2113 # The full range of timeout values allowed goes from 1
2114 # through 2,147,483,647 seconds.
2115 #
2116 # This value can be overridden in the PathMatcher configuration of the
2117 # UrlMap that references this backend service.
2118 #
2119 # Not supported when the backend service is referenced by a URL map that is
2120 # bound to target gRPC proxy that has validateForProxyless field set to true.
2121 # Instead, use maxStreamDuration.
2122 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
2123 # when the backend protocol is SSL, HTTPS or HTTP2.
2124 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
2125 # networksecurity.googleapis.com namespace. Can be used in authenticating
2126 # TLS connections to the backend, as specified by the authenticationMode
2127 # field. Can only be specified if authenticationMode is not NONE.
2128 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
2129 #
2130 #
2131 # Use this property to configure the load balancer back-end to use
2132 # certificates and roots of trust provisioned by the Managed Workload
2133 # Identity system.
2134 #
2135 # The `identity` property is the
2136 # fully-specified SPIFFE ID to use in the SVID presented by the Load
2137 # Balancer Workload.
2138 #
2139 # The SPIFFE ID must be a resource starting with the
2140 # `trustDomain` property value, followed by the path to the Managed
2141 # Workload Identity.
2142 #
2143 # Supported SPIFFE ID format:
2144 #
2145 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
2146 #
2147 #
2148 # The Trust Domain within the Managed Identity must refer to a valid
2149 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
2150 # will be inherited from the Workload Identity Pool.
2151 #
2152 # Restrictions:
2153 #
2154 # - If you set the `identity` property, you cannot manually set
2155 # the following fields:
2156 # - tlsSettings.sni
2157 # - tlsSettings.subjectAltNames
2158 # - tlsSettings.authenticationConfig
2159 #
2160 #
2161 # When defining a `identity` for a RegionBackendServices, the
2162 # corresponding Workload Identity Pool must have a ca_pool
2163 # configured in the same region.
2164 #
2165 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
2166 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
2167 # balancer sends this string as the SNI hostname in the TLS connection to
2168 # the backend, and requires that this string match a Subject Alternative
2169 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
2170 # NEG backend, if the SNI is specified here, the load balancer uses it
2171 # regardless of whether the Regional Internet NEG is specified with FQDN or
2172 # IP address and port. When both sni and subjectAltNames[] are specified,
2173 # the load balancer matches the backend certificate&#x27;s SAN only to
2174 # subjectAltNames[].
2175 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
2176 # verifies during a TLS handshake with the backend. When the server
2177 # presents its X.509 certificate to the Load Balancer, the Load Balancer
2178 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
2179 # match one of the subjectAltNames in the list. This field is limited to 5
2180 # entries. When both sni and subjectAltNames[] are specified, the load
2181 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
2182 { # A Subject Alternative Name that the load balancer matches against the SAN
2183 # field in the TLS certificate provided by the backend, specified as either
2184 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
2185 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
2186 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
2187 },
2188 ],
2189 },
2190 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
2191 {
2192 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
2193 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
2194 # and ForwardingRule.
2195 },
2196 ],
2197 }</pre>
2198 </div>
2199
2200 <div class="method">
2201 <code class="details" id="getHealth">getHealth(project, region, backendService, body=None, x__xgafv=None)</code>
2202 <pre>Gets the most recent health check results for this
2203 regional BackendService.
2204
2205 Args:
2206 project: string, A parameter (required)
2207 region: string, Name of the region scoping this request. (required)
2208 backendService: string, Name of the BackendService resource for which to get health. (required)
2209 body: object, The request body.
2210 The object takes the form of:
2211
2212 {
2213 &quot;group&quot;: &quot;A String&quot;, # A URI referencing one of the instance groups or network endpoint groups
2214 # listed in the backend service.
2215 }
2216
2217 x__xgafv: string, V1 error format.
2218 Allowed values
2219 1 - v1 error format
2220 2 - v2 error format
2221
2222 Returns:
2223 An object of the form:
2224
2225 {
2226 &quot;annotations&quot;: { # Metadata defined as annotations on the network endpoint group.
2227 &quot;a_key&quot;: &quot;A String&quot;,
2228 },
2229 &quot;healthStatus&quot;: [ # Health state of the backend instances or endpoints in requested instance or
2230 # network endpoint group, determined based on configured health checks.
2231 {
2232 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
2233 &quot;a_key&quot;: &quot;A String&quot;,
2234 },
2235 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
2236 # instance.
2237 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
2238 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
2239 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
2240 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
2241 # rule&#x27;s IP address assigned to this instance. For other types of load
2242 # balancing, the field indicates VM internal ip.
2243 &quot;ipv6Address&quot;: &quot;A String&quot;,
2244 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
2245 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
2246 # health-checked.
2247 &quot;weight&quot;: &quot;A String&quot;,
2248 &quot;weightError&quot;: &quot;A String&quot;,
2249 },
2250 ],
2251 &quot;kind&quot;: &quot;compute#backendServiceGroupHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend
2252 # services.
2253 }</pre>
2254 </div>
2255
2256 <div class="method">
2257 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
2258 <pre>Gets the access control policy for a resource. May be empty if no such
2259 policy or resource exists.
2260
2261 Args:
2262 project: string, Project ID for this request. (required)
2263 region: string, The name of the region for this request. (required)
2264 resource: string, Name or id of the resource for this request. (required)
2265 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
2266 x__xgafv: string, V1 error format.
2267 Allowed values
2268 1 - v1 error format
2269 2 - v2 error format
2270
2271 Returns:
2272 An object of the form:
2273
2274 { # An Identity and Access Management (IAM) policy, which specifies access
2275 # controls for Google Cloud resources.
2276 #
2277 #
2278 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2279 # `members`, or principals, to a single `role`. Principals can be user
2280 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2281 # `role` is a named list of permissions; each `role` can be an IAM predefined
2282 # role or a user-created custom role.
2283 #
2284 # For some types of Google Cloud resources, a `binding` can also specify a
2285 # `condition`, which is a logical expression that allows access to a resource
2286 # only if the expression evaluates to `true`. A condition can add constraints
2287 # based on attributes of the request, the resource, or both. To learn which
2288 # resources support conditions in their IAM policies, see the
2289 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2290 #
2291 # **JSON example:**
2292 #
2293 # ```
2294 # {
2295 # &quot;bindings&quot;: [
2296 # {
2297 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2298 # &quot;members&quot;: [
2299 # &quot;user:[email protected]&quot;,
2300 # &quot;group:[email protected]&quot;,
2301 # &quot;domain:google.com&quot;,
2302 # &quot;serviceAccount:[email protected]&quot;
2303 # ]
2304 # },
2305 # {
2306 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2307 # &quot;members&quot;: [
2308 # &quot;user:[email protected]&quot;
2309 # ],
2310 # &quot;condition&quot;: {
2311 # &quot;title&quot;: &quot;expirable access&quot;,
2312 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2313 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2314 # }
2315 # }
2316 # ],
2317 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2318 # &quot;version&quot;: 3
2319 # }
2320 # ```
2321 #
2322 # **YAML example:**
2323 #
2324 # ```
2325 # bindings:
2326 # - members:
2327 # - user:[email protected]
2328 # - group:[email protected]
2329 # - domain:google.com
2330 # - serviceAccount:[email protected]
2331 # role: roles/resourcemanager.organizationAdmin
2332 # - members:
2333 # - user:[email protected]
2334 # role: roles/resourcemanager.organizationViewer
2335 # condition:
2336 # title: expirable access
2337 # description: Does not grant access after Sep 2020
2338 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2339 # etag: BwWWja0YfJA=
2340 # version: 3
2341 # ```
2342 #
2343 # For a description of IAM and its features, see the
2344 # [IAM documentation](https://cloud.google.com/iam/docs/).
2345 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2346 { # Specifies the audit configuration for a service.
2347 # The configuration determines which permission types are logged, and what
2348 # identities, if any, are exempted from logging.
2349 # An AuditConfig must have one or more AuditLogConfigs.
2350 #
2351 # If there are AuditConfigs for both `allServices` and a specific service,
2352 # the union of the two AuditConfigs is used for that service: the log_types
2353 # specified in each AuditConfig are enabled, and the exempted_members in each
2354 # AuditLogConfig are exempted.
2355 #
2356 # Example Policy with multiple AuditConfigs:
2357 #
2358 # {
2359 # &quot;audit_configs&quot;: [
2360 # {
2361 # &quot;service&quot;: &quot;allServices&quot;,
2362 # &quot;audit_log_configs&quot;: [
2363 # {
2364 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2365 # &quot;exempted_members&quot;: [
2366 # &quot;user:[email protected]&quot;
2367 # ]
2368 # },
2369 # {
2370 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2371 # },
2372 # {
2373 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2374 # }
2375 # ]
2376 # },
2377 # {
2378 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2379 # &quot;audit_log_configs&quot;: [
2380 # {
2381 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2382 # },
2383 # {
2384 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2385 # &quot;exempted_members&quot;: [
2386 # &quot;user:[email protected]&quot;
2387 # ]
2388 # }
2389 # ]
2390 # }
2391 # ]
2392 # }
2393 #
2394 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2395 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2396 # `[email protected]` from DATA_WRITE logging.
2397 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2398 { # Provides the configuration for logging a type of permissions.
2399 # Example:
2400 #
2401 # {
2402 # &quot;audit_log_configs&quot;: [
2403 # {
2404 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2405 # &quot;exempted_members&quot;: [
2406 # &quot;user:[email protected]&quot;
2407 # ]
2408 # },
2409 # {
2410 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2411 # }
2412 # ]
2413 # }
2414 #
2415 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2416 # [email protected] from DATA_READ logging.
2417 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2418 # permission.
2419 # Follows the same format of Binding.members.
2420 &quot;A String&quot;,
2421 ],
2422 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2423 },
2424 ],
2425 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2426 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2427 # `allServices` is a special value that covers all services.
2428 },
2429 ],
2430 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2431 # may specify a `condition` that determines how and when the `bindings` are
2432 # applied. Each of the `bindings` must contain at least one principal.
2433 #
2434 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2435 # of these principals can be Google groups. Each occurrence of a principal
2436 # counts towards these limits. For example, if the `bindings` grant 50
2437 # different roles to `user:[email protected]`, and not to any other
2438 # principal, then you can add another 1,450 principals to the `bindings` in
2439 # the `Policy`.
2440 { # Associates `members`, or principals, with a `role`.
2441 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2442 #
2443 # If the condition evaluates to `true`, then this binding applies to the
2444 # current request.
2445 #
2446 # If the condition evaluates to `false`, then this binding does not apply to
2447 # the current request. However, a different role binding might grant the same
2448 # role to one or more of the principals in this binding.
2449 #
2450 # To learn which resources support conditions in their IAM policies, see the
2451 # [IAM
2452 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2453 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2454 # are documented at https://github.com/google/cel-spec.
2455 #
2456 # Example (Comparison):
2457 #
2458 # title: &quot;Summary size limit&quot;
2459 # description: &quot;Determines if a summary is less than 100 chars&quot;
2460 # expression: &quot;document.summary.size() &lt; 100&quot;
2461 #
2462 # Example (Equality):
2463 #
2464 # title: &quot;Requestor is owner&quot;
2465 # description: &quot;Determines if requestor is the document owner&quot;
2466 # expression: &quot;document.owner == request.auth.claims.email&quot;
2467 #
2468 # Example (Logic):
2469 #
2470 # title: &quot;Public documents&quot;
2471 # description: &quot;Determine whether the document should be publicly visible&quot;
2472 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2473 #
2474 # Example (Data Manipulation):
2475 #
2476 # title: &quot;Notification string&quot;
2477 # description: &quot;Create a notification string with a timestamp.&quot;
2478 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2479 #
2480 # The exact variables and functions that may be referenced within an expression
2481 # are determined by the service that evaluates it. See the service
2482 # documentation for additional information.
2483 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2484 # describes the expression, e.g. when hovered over it in a UI.
2485 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2486 # syntax.
2487 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2488 # reporting, e.g. a file name and a position in the file.
2489 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2490 # its purpose. This can be used e.g. in UIs which allow to enter the
2491 # expression.
2492 },
2493 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2494 # `members` can have the following values:
2495 #
2496 # * `allUsers`: A special identifier that represents anyone who is
2497 # on the internet; with or without a Google account.
2498 #
2499 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2500 # who is authenticated with a Google account or a service account.
2501 # Does not include identities that come from external identity providers
2502 # (IdPs) through identity federation.
2503 #
2504 # * `user:{emailid}`: An email address that represents a specific Google
2505 # account. For example, `[email protected]` .
2506 #
2507 #
2508 # * `serviceAccount:{emailid}`: An email address that represents a Google
2509 # service account. For example,
2510 # `[email protected]`.
2511 #
2512 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2513 # identifier for a
2514 # [Kubernetes service
2515 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2516 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2517 #
2518 # * `group:{emailid}`: An email address that represents a Google group.
2519 # For example, `[email protected]`.
2520 #
2521 #
2522 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2523 # users of that domain. For example, `google.com` or `example.com`.
2524 #
2525 #
2526 #
2527 #
2528 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2529 # A single identity in a workforce identity pool.
2530 #
2531 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2532 # All workforce identities in a group.
2533 #
2534 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2535 # All workforce identities with a specific attribute value.
2536 #
2537 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2538 # All identities in a workforce identity pool.
2539 #
2540 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2541 # A single identity in a workload identity pool.
2542 #
2543 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2544 # A workload identity pool group.
2545 #
2546 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2547 # All identities in a workload identity pool with a certain attribute.
2548 #
2549 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2550 # All identities in a workload identity pool.
2551 #
2552 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2553 # identifier) representing a user that has been recently deleted. For
2554 # example, `[email protected]?uid=123456789012345678901`. If the user is
2555 # recovered, this value reverts to `user:{emailid}` and the recovered user
2556 # retains the role in the binding.
2557 #
2558 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2559 # unique identifier) representing a service account that has been recently
2560 # deleted. For example,
2561 # `[email protected]?uid=123456789012345678901`.
2562 # If the service account is undeleted, this value reverts to
2563 # `serviceAccount:{emailid}` and the undeleted service account retains the
2564 # role in the binding.
2565 #
2566 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2567 # identifier) representing a Google group that has been recently
2568 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2569 # the group is recovered, this value reverts to `group:{emailid}` and the
2570 # recovered group retains the role in the binding.
2571 #
2572 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2573 # Deleted single identity in a workforce identity pool. For example,
2574 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2575 &quot;A String&quot;,
2576 ],
2577 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2578 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2579 #
2580 # For an overview of the IAM roles and permissions, see the
2581 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2582 # a list of the available pre-defined roles, see
2583 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2584 },
2585 ],
2586 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2587 # prevent simultaneous updates of a policy from overwriting each other.
2588 # It is strongly suggested that systems make use of the `etag` in the
2589 # read-modify-write cycle to perform policy updates in order to avoid race
2590 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2591 # systems are expected to put that etag in the request to `setIamPolicy` to
2592 # ensure that their change will be applied to the same version of the policy.
2593 #
2594 # **Important:** If you use IAM Conditions, you must include the `etag` field
2595 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2596 # you to overwrite a version `3` policy with a version `1` policy, and all of
2597 # the conditions in the version `3` policy are lost.
2598 &quot;version&quot;: 42, # Specifies the format of the policy.
2599 #
2600 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2601 # are rejected.
2602 #
2603 # Any operation that affects conditional role bindings must specify version
2604 # `3`. This requirement applies to the following operations:
2605 #
2606 # * Getting a policy that includes a conditional role binding
2607 # * Adding a conditional role binding to a policy
2608 # * Changing a conditional role binding in a policy
2609 # * Removing any role binding, with or without a condition, from a policy
2610 # that includes conditions
2611 #
2612 # **Important:** If you use IAM Conditions, you must include the `etag` field
2613 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2614 # you to overwrite a version `3` policy with a version `1` policy, and all of
2615 # the conditions in the version `3` policy are lost.
2616 #
2617 # If a policy does not include any conditions, operations on that policy may
2618 # specify any valid version or leave the field unset.
2619 #
2620 # To learn which resources support conditions in their IAM policies, see the
2621 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2622 }</pre>
2623 </div>
2624
2625 <div class="method">
2626 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
2627 <pre>Creates a regional BackendService resource in the specified project using
2628 the data included in the request. For more information, see
2629 Backend services overview.
2630
2631 Args:
2632 project: string, Project ID for this request. (required)
2633 region: string, Name of the region scoping this request. (required)
2634 body: object, The request body.
2635 The object takes the form of:
2636
2637 { # Represents a Backend Service resource.
2638 #
2639 # A backend service defines how Google Cloud load balancers distribute traffic.
2640 # The backend service configuration contains a set of values, such as the
2641 # protocol used to connect to backends, various distribution and session
2642 # settings, health checks, and timeouts. These settings provide fine-grained
2643 # control over how your load balancer behaves. Most of the settings have
2644 # default values that allow for easy configuration if you need to get started
2645 # quickly.
2646 #
2647 # Backend services in Google Compute Engine can be either regionally or
2648 # globally scoped.
2649 #
2650 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
2651 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
2652 #
2653 # For more information, seeBackend
2654 # Services.
2655 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
2656 # Load Balancers and Traffic Director and requires
2657 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
2658 #
2659 # If set to 0, the cookie is non-persistent and lasts only until
2660 # the end of the browser session (or equivalent). The maximum allowed value
2661 # is two weeks (1,209,600).
2662 #
2663 # Not supported when the backend service is referenced by a URL map that is
2664 # bound to target gRPC proxy that has validateForProxyless field set to true.
2665 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
2666 # load balancing scheme set to INTERNAL_SELF_MANAGED.
2667 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
2668 { # Message containing information of one individual backend.
2669 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
2670 # handle additional traffic or is fully loaded. For usage guidelines, see
2671 # Connection balancing mode.
2672 #
2673 # Backends must use compatible balancing modes. For more information, see
2674 # Supported balancing modes and target capacity settings and
2675 # Restrictions and guidance for instance groups.
2676 #
2677 # Note: Currently, if you use the API to configure incompatible balancing
2678 # modes, the configuration might be accepted even though it has no impact
2679 # and is ignored. Specifically, Backend.maxUtilization is ignored when
2680 # Backend.balancingMode is RATE. In the future, this incompatible combination
2681 # will be rejected.
2682 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
2683 # mode.
2684 # The default value is 1, which means the group serves up to
2685 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
2686 # completely drained, offering 0% of its available capacity. The valid ranges
2687 # are 0.0 and [0.1,1.0].
2688 # You cannot configure a setting larger than 0 and smaller than0.1.
2689 # You cannot configure a setting of 0 when there is only one
2690 # backend attached to the backend service.
2691 #
2692 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
2693 # internet NEGs, regional serverless NEGs, and PSC NEGs.
2694 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
2695 # BalancingMode.
2696 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
2697 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
2698 # Monitoring, but is not used for load balancing.
2699 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
2700 # balancing mode. The valid range is [0.0, 1.0].
2701 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2702 # long and match the regular expression
2703 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2704 # first character must be a lowercase letter, and all following
2705 # characters must be a dash, period, underscore, lowercase letter, or
2706 # digit, except the last character, which cannot be a dash, period, or
2707 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2708 # field can only be used for a global or regional backend service with the
2709 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2710 },
2711 ],
2712 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2713 # create the resource.
2714 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
2715 # failover backend can be configured for a given BackendService.
2716 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
2717 # group or network endpoint
2718 # group (NEG) resource. To determine what types of backends a load
2719 # balancer supports, see the [Backend services
2720 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
2721 #
2722 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
2723 # or NEG. Partial URLs are not supported.
2724 #
2725 # If haPolicy is specified, backends must refer to NEG resources of type
2726 # GCE_VM_IP.
2727 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2728 # guidelines, seeConnection
2729 # balancing mode and Utilization
2730 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
2731 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2732 # guidelines, seeConnection
2733 # balancing mode and Utilization
2734 # balancing mode.
2735 #
2736 # Not available if the backend&#x27;s balancingMode isRATE.
2737 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
2738 # For usage guidelines, seeConnection
2739 # balancing mode and Utilization
2740 # balancing mode.
2741 #
2742 # Not available if the backend&#x27;s balancingMode isRATE.
2743 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
2744 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
2745 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
2746 # Not available if backend&#x27;s balancingMode is RATE
2747 # or CONNECTION.
2748 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
2749 # Not available if backend&#x27;s balancingMode is RATE
2750 # or CONNECTION.
2751 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
2752 # usage guidelines, seeRate
2753 # balancing mode and Utilization
2754 # balancing mode.
2755 #
2756 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2757 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2758 # guidelines, seeRate
2759 # balancing mode and Utilization
2760 # balancing mode.
2761 #
2762 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2763 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2764 # guidelines, seeRate
2765 # balancing mode and Utilization
2766 # balancing mode.
2767 #
2768 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2769 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
2770 #
2771 # For usage guidelines, seeUtilization
2772 # balancing mode.
2773 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
2774 # the backend.
2775 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
2776 },
2777 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
2778 # sending traffic to backends with default preference. The possible values
2779 # are:
2780 #
2781 # - PREFERRED: Backends with this preference level will be
2782 # filled up to their capacity limits first, based on RTT.
2783 # - DEFAULT: If preferred backends don&#x27;t have enough
2784 # capacity, backends in this layer would be used and traffic would be
2785 # assigned based on the load balancing algorithm you use. This is the
2786 # default
2787 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
2788 # Attachment).
2789 # e.g.
2790 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
2791 # for Cloud Run service.
2792 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
2793 # for PSC Service Attachment.
2794 &quot;trafficDuration&quot;: &quot;A String&quot;,
2795 },
2796 ],
2797 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
2798 # specified load balancer types.
2799 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2800 # Pragma or Authorization headers. Up to 5 headers can be specified.
2801 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2802 { # Bypass the cache when the specified request headers are present,
2803 # e.g. Pragma or Authorization headers. Values are case insensitive.
2804 # The presence of such a header overrides the cache_mode setting.
2805 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2806 # Values are case-insensitive.
2807 },
2808 ],
2809 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
2810 # CDN.
2811 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
2812 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2813 &quot;A String&quot;,
2814 ],
2815 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
2816 # The name=value pair will be used in the cache key Cloud CDN generates.
2817 &quot;A String&quot;,
2818 ],
2819 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
2820 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
2821 # query_string_whitelist and query_string_blacklist. If neither is set, the
2822 # entire query string will be included. If false, the query string will be
2823 # excluded from the cache key entirely.
2824 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
2825 # parameters will be included. Either specify query_string_whitelist or
2826 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2827 # not treated as delimiters.
2828 &quot;A String&quot;,
2829 ],
2830 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
2831 # parameters will be excluded. Either specify query_string_whitelist or
2832 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2833 # not treated as delimiters.
2834 &quot;A String&quot;,
2835 ],
2836 },
2837 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2838 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2839 # headers to cache content. Responses without these headers will not be
2840 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2841 # every request, potentially impacting performance and increasing load on
2842 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2843 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2844 # Warning: this may result in Cloud CDN caching private,
2845 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2846 # including common image formats, media (video and audio), and web assets
2847 # (JavaScript and CSS). Requests and responses that are marked as
2848 # uncacheable, as well as dynamic content (including HTML), will not be
2849 # cached.
2850 #
2851 # If no value is provided for cdnPolicy.cacheMode, it defaults
2852 # to CACHE_ALL_STATIC.
2853 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2854 # used to clamp the max-age (or Expires) value sent to the client. With
2855 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2856 # response max-age directive, along with a &quot;public&quot; directive. For
2857 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2858 # from the origin (if specified), or else sets the response max-age
2859 # directive to the lesser of the client_ttl and default_ttl, and also
2860 # ensures a &quot;public&quot; cache-control directive is present.
2861 # If a client TTL is not specified, a default value (1 hour) will be used.
2862 # The maximum allowed value is 31,622,400s (1 year).
2863 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2864 # responses that do not have an existing valid TTL (max-age or s-maxage).
2865 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2866 # The value of defaultTTL cannot be set to a value greater than that of
2867 # maxTTL, but can be equal.
2868 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2869 # will overwrite the TTL set in all responses. The maximum allowed value is
2870 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2871 # evicted from the cache before the defined TTL.
2872 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2873 # origin.
2874 # Cache directives that attempt to set a max-age or s-maxage higher than
2875 # this, or an Expires header more than maxTTL seconds in the future will
2876 # be capped at the value of maxTTL, as if it were the value of an
2877 # s-maxage Cache-Control directive.
2878 # Headers sent to the client will not be modified.
2879 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2880 # The maximum allowed value is 31,622,400s (1 year), noting that
2881 # infrequently accessed objects may be evicted from the cache before
2882 # the defined TTL.
2883 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2884 # to apply fine-grained caching for common errors or redirects.
2885 # This can reduce the load on your origin and improve end-user
2886 # experience by reducing response latency.
2887 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2888 # negative caching applies to responses with the specified response code
2889 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2890 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2891 # to all responses with the specified response code, and override any
2892 # caching headers.
2893 # By default, Cloud CDN will apply the following default TTLs to these
2894 # status codes:
2895 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2896 # HTTP 404 (Not Found), 410 (Gone),
2897 # 451 (Unavailable For Legal Reasons): 120s
2898 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2899 # These defaults can be overridden in negative_caching_policy.
2900 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2901 # negative_caching must be enabled to configure negative_caching_policy.
2902 # Omitting the policy and leaving negative_caching enabled will use
2903 # Cloud CDN&#x27;s default cache TTLs.
2904 # Note that when specifying an explicit negative_caching_policy, you
2905 # should take care to specify a cache TTL for all response codes
2906 # that you wish to cache. Cloud CDN will not apply any default
2907 # negative caching when a policy exists.
2908 { # Specify CDN TTLs for response error codes.
2909 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2910 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2911 # specified as values, and you cannot specify a status code more than
2912 # once.
2913 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2914 # corresponding status code.
2915 # The maximum allowed value is 1800s (30 minutes), noting that
2916 # infrequently accessed objects may be evicted from the cache before the
2917 # defined TTL.
2918 },
2919 ],
2920 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2921 # requests into a small number of requests to the origin.
2922 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2923 # content with the origin, or when an error is encountered when refreshing
2924 # the cache.
2925 # This setting defines the default &quot;max-stale&quot; duration for any cached
2926 # responses that do not specify a max-stale directive. Stale responses that
2927 # exceed the TTL configured here will not be served. The default limit
2928 # (max-stale) is 86400s (1 day), which will allow stale content to be
2929 # served up to this limit beyond the max-age (or s-maxage) of a cached
2930 # response.
2931 # The maximum allowed value is 604800 (1 week).
2932 # Set this to zero (0) to disable serve-while-stale.
2933 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2934 # considered fresh. After this time period, the response will be
2935 # revalidated before being served. Defaults to 1hr (3600s). When serving
2936 # responses to signed URL requests, Cloud CDN will internally behave as
2937 # though all responses from this backend had a &quot;Cache-Control:
2938 # public, max-age=[TTL]&quot; header, regardless of any existing
2939 # Cache-Control header. The actual headers served in responses will not be
2940 # altered.
2941 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2942 &quot;A String&quot;,
2943 ],
2944 },
2945 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
2946 # backend service.
2947 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
2948 # as a count of seconds and fractions of seconds at nanosecond
2949 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2950 # or &quot;month&quot;. Range is approximately 10,000 years.
2951 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2952 # Durations less than one second are represented with a 0
2953 # `seconds` field and a positive `nanos` field. Must be from 0
2954 # to 999,999,999 inclusive.
2955 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2956 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2957 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2958 },
2959 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
2960 # there is no limit.
2961 #
2962 # Not supported when the backend service is referenced by a URL map that is
2963 # bound to target gRPC proxy that has validateForProxyless field set to true.
2964 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
2965 # not specified, there is no limit.
2966 #
2967 # Not supported when the backend service is referenced by a URL map that is
2968 # bound to target gRPC proxy that has validateForProxyless field set to true.
2969 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
2970 # service. If not specified, there is no limit.
2971 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
2972 # This parameter is respected by both the HTTP/1.1 and HTTP/2
2973 # implementations. If not specified, there is no limit. Setting this
2974 # parameter to 1 will effectively disable keep alive.
2975 #
2976 # Not supported when the backend service is referenced by a URL map that is
2977 # bound to target gRPC proxy that has validateForProxyless field set to true.
2978 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
2979 # not specified, the default is 1.
2980 #
2981 # Not supported when the backend service is referenced by a URL map that is
2982 # bound to target gRPC proxy that has validateForProxyless field set to true.
2983 },
2984 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2985 # the client&#x27;s Accept-Encoding header.
2986 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
2987 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
2988 # instance. For supported load balancers and protocols, as described inEnabling
2989 # connection draining.
2990 },
2991 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
2992 # tracking policy settings are only available for external passthrough
2993 # Network Load Balancers and internal passthrough Network Load Balancers.
2994 #
2995 # connectionTrackingPolicy cannot be specified with haPolicy.
2996 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
2997 # value is DEFAULT_FOR_PROTOCOL.
2998 #
2999 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
3000 # persist on unhealthy backends only for connection-oriented protocols
3001 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
3002 # Affinity is configured for 5-tuple. They do not persist forUDP.
3003 #
3004 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
3005 # the existing connections on the unhealthy backend are never persisted on
3006 # the unhealthy backend. They are always diverted to newly selected healthy
3007 # backends (unless all backends are unhealthy).
3008 #
3009 # If set to ALWAYS_PERSIST, existing connections always
3010 # persist on unhealthy backends regardless of protocol and session
3011 # affinity. It is generally not recommended to use this mode overriding the
3012 # default.
3013 #
3014 # For more details, see [Connection Persistence for Network Load
3015 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
3016 # and [Connection Persistence for Internal TCP/UDP Load
3017 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
3018 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
3019 # Balancers. This option is not available publicly.
3020 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
3021 # matching traffic (in seconds).
3022 #
3023 # For internal passthrough Network Load Balancers:
3024 #
3025 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
3026 # - It can be set only if Connection Tracking is less than 5-tuple
3027 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
3028 # Mode is PER_SESSION).
3029 #
3030 #
3031 #
3032 # For external passthrough Network Load Balancers the default is 60
3033 # seconds. This option is not available publicly.
3034 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
3035 # options:
3036 #
3037 # - PER_CONNECTION: This is the default mode. The Connection
3038 # Tracking is performed as per the Connection Key (default Hash Method) for
3039 # the specific protocol.
3040 # - PER_SESSION: The Connection Tracking is performed as per
3041 # the configured Session Affinity. It matches the configured Session
3042 # Affinity.
3043 #
3044 #
3045 #
3046 # For more details, see [Tracking Mode for Network Load
3047 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
3048 # and [Tracking Mode for Internal TCP/UDP Load
3049 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
3050 },
3051 &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
3052 # affinity based on HTTP headers, cookies or other properties. This load
3053 # balancing policy is applicable only for HTTP connections. The affinity to a
3054 # particular destination host will be lost when one or more hosts are
3055 # added/removed from the destination service. This field specifies parameters
3056 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
3057 #
3058 # This field is applicable to either:
3059 #
3060 # - A regional backend service with the service protocol set to HTTP,
3061 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3062 # INTERNAL_MANAGED.
3063 # - A global backend service with the
3064 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3065 &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
3066 # be used as the hash key for the consistent hash load balancer. If the
3067 # cookie is not present, it will be generated. This field is applicable if
3068 # the sessionAffinity is set to HTTP_COOKIE.
3069 #
3070 # Not supported when the backend service is referenced by a URL map that is
3071 # bound to target gRPC proxy that has validateForProxyless field set to true.
3072 # for load balancing policies that use a consistent hash.
3073 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3074 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3075 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3076 # as a count of seconds and fractions of seconds at nanosecond
3077 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3078 # or &quot;month&quot;. Range is approximately 10,000 years.
3079 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3080 # Durations less than one second are represented with a 0
3081 # `seconds` field and a positive `nanos` field. Must be from 0
3082 # to 999,999,999 inclusive.
3083 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3084 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3085 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3086 },
3087 },
3088 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
3089 # applicable if the sessionAffinity is set toHEADER_FIELD.
3090 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
3091 # 1024. Larger ring sizes result in more granular load distributions. If the
3092 # number of hosts in the load balancing pool is larger than the ring size,
3093 # each host will be assigned a single virtual node.
3094 },
3095 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3096 # text format.
3097 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
3098 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
3099 # locality_lb_policy.
3100 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
3101 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
3102 # long and match the regular expression
3103 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
3104 # first character must be a lowercase letter, and all following
3105 # characters must be a dash, period, underscore, lowercase letter, or
3106 # digit, except the last character, which cannot be a dash, period, or
3107 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
3108 # field can only be used for a global or regional backend service with the
3109 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
3110 },
3111 ],
3112 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
3113 # custom
3114 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
3115 &quot;A String&quot;,
3116 ],
3117 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
3118 # custom
3119 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
3120 &quot;A String&quot;,
3121 ],
3122 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3123 # create the resource.
3124 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
3125 # backend service with dynamic forwarding feature which together with Service
3126 # Extension allows customized and complex routing logic.
3127 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
3128 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
3129 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
3130 },
3131 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
3132 # service. Some ranges are restricted: Restricted
3133 # ranges.
3134 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
3135 },
3136 },
3137 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
3138 # this backend service.
3139 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
3140 # global external Application Load Balancer.
3141 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
3142 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
3143 #
3144 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
3145 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
3146 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
3147 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
3148 # externalManagedMigrationTestingPercentage.
3149 #
3150 # Rolling back a migration requires the states to be set in reverse order. So
3151 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
3152 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
3153 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
3154 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
3155 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
3156 # external Application Load Balancer.
3157 #
3158 # The value of this field must be in the range [0, 100].
3159 #
3160 # Session affinity options will slightly affect this routing behavior, for
3161 # more details, see:Session
3162 # Affinity.
3163 #
3164 # This value can only be set if the loadBalancingScheme in the BackendService
3165 # is set to EXTERNAL (when using the classic Application Load Balancer) and
3166 # the migration state is TEST_BY_PERCENTAGE.
3167 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
3168 # as a backup (failover) backend.
3169 # For load balancers that have configurable failover:
3170 # [Internal passthrough Network Load
3171 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3172 # and [external passthrough Network Load
3173 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3174 #
3175 # failoverPolicy cannot be specified with haPolicy.
3176 # failover:
3177 # [Internal passthrough Network Load
3178 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3179 # and [external passthrough
3180 # Network Load
3181 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3182 # On failover or failback, this field indicates whether connection draining
3183 # will be honored. Google Cloud has a fixed connection draining timeout of
3184 # 10 minutes. A setting of true terminates existing TCP
3185 # connections to the active pool during failover and failback, immediately
3186 # draining traffic. A setting of false allows existing TCP
3187 # connections to persist, even on VMs no longer in the active pool, for up
3188 # to the duration of the connection draining timeout (10 minutes).
3189 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
3190 #
3191 # The default is false.
3192 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
3193 # load balancer are dropped when all primary and all backup backend VMs are
3194 # unhealthy.If set to false, connections are distributed
3195 # among all primary VMs when all primary and all backup backend VMs are
3196 # unhealthy.
3197 # For load balancers that have configurable
3198 # failover:
3199 # [Internal passthrough
3200 # Network Load
3201 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3202 # and [external passthrough
3203 # Network Load
3204 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3205 # The default is false.
3206 &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
3207 # failover when the number of healthy primary VMs equals zero.
3208 # For all other values, the load balancer performs a failover when the
3209 # total number of healthy primary VMs is less than this ratio.
3210 # For load balancers that have configurable
3211 # failover:
3212 # [Internal TCP/UDP Load
3213 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3214 # and [external TCP/UDP Load
3215 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3216 },
3217 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
3218 # This field is used in optimistic locking. This field will be ignored when
3219 # inserting a BackendService. An up-to-date fingerprint must be provided in
3220 # order to update the BackendService, otherwise the request will
3221 # fail with error 412 conditionNotMet.
3222 #
3223 # To see the latest fingerprint, make a get() request to
3224 # retrieve a BackendService.
3225 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
3226 # Protocol Forwarding.
3227 #
3228 # The backends of this regional backend service must only specify zonal
3229 # network endpoint groups (NEGs) of type GCE_VM_IP.
3230 #
3231 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
3232 # regional backend service must set the network field. All zonal NEGs must
3233 # belong to the same network. However, individual NEGs can
3234 # belong to different subnetworks of that network.
3235 #
3236 # When haPolicy is specified, the set of attached network endpoints across
3237 # all backends comprise an High Availability domain from which one endpoint
3238 # is selected as the active endpoint (the leader) that receives all
3239 # traffic.
3240 #
3241 # haPolicy can be added only at backend service creation time. Once set up,
3242 # it cannot be deleted.
3243 #
3244 # Note that haPolicy is not for load balancing, and therefore cannot be
3245 # specified with sessionAffinity, connectionTrackingPolicy, and
3246 # failoverPolicy.
3247 #
3248 # haPolicy requires customers to be responsible for tracking backend
3249 # endpoint health and electing a leader among the healthy endpoints.
3250 # Therefore, haPolicy cannot be specified with healthChecks.
3251 #
3252 # haPolicy can only be specified for External Passthrough Network Load
3253 # Balancers and Internal Passthrough Network Load Balancers.
3254 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
3255 # achieve it.
3256 #
3257 # Supported values are:
3258 #
3259 # - DISABLED: Fast IP Move is disabled. You can only use the
3260 # haPolicy.leader API to update the leader.
3261 # - &gt;GARP_RA: Provides a method to very quickly define a new network
3262 # endpoint as the leader. This method is faster than updating the leader
3263 # using the haPolicy.leader API. Fast IP move works as follows: The VM
3264 # hosting the network endpoint that should become the new leader sends
3265 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
3266 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
3267 # temporarily associates the forwarding rule IP address with that VM, and
3268 # both new and in-flight packets are quickly delivered to that VM.
3269 #
3270 #
3271 #
3272 # Note the important properties of the Fast IP Move functionality:
3273 #
3274 # - The GARP/RA-initiated re-routing stays active for approximately 20
3275 # minutes. After triggering fast failover, you must also
3276 # appropriately set the haPolicy.leader.
3277 # - The new leader instance should continue to send GARP/RA packets
3278 # periodically every 10 seconds until at least 10 minutes after updating
3279 # the haPolicy.leader (but stop immediately if it is no longer the leader).
3280 # - After triggering a fast failover, we recommend that you wait at least
3281 # 3 seconds before sending another GARP/RA packet from a different VM
3282 # instance to avoid race conditions.
3283 # - Don&#x27;t send GARP/RA packets from different VM
3284 # instances at the same time. If multiple instances continue to send
3285 # GARP/RA packets, traffic might be routed to different destinations in an
3286 # alternating order. This condition ceases when a single instance
3287 # issues a GARP/RA packet.
3288 # - The GARP/RA request always takes priority over the leader API.
3289 # Using the haPolicy.leader API to change the leader to a different
3290 # instance will have no effect until the GARP/RA request becomes
3291 # inactive.
3292 # - The GARP/RA packets should follow the GARP/RA
3293 # Packet Specifications..
3294 # - When multiple forwarding rules refer to a regional backend service,
3295 # you need only send a GARP or RA packet for a single forwarding rule
3296 # virtual IP. The virtual IPs for all forwarding rules targeting the same
3297 # backend service will also be moved to the sender of the GARP or RA
3298 # packet.
3299 #
3300 #
3301 #
3302 # The following are the Fast IP Move limitations (that is, when fastIPMove
3303 # is not DISABLED):
3304 #
3305 # - Multiple forwarding rules cannot use the same IP address if one of
3306 # them refers to a regional backend service with fastIPMove.
3307 # - The regional backend service must set the network field, and all
3308 # NEGs must belong to that network. However, individual
3309 # NEGs can belong to different subnetworks of that network.
3310 # - The maximum number of network endpoints across all backends of a
3311 # backend service with fastIPMove is 32.
3312 # - The maximum number of backend services with fastIPMove that can have
3313 # the same network endpoint attached to one of its backends is 64.
3314 # - The maximum number of backend services with fastIPMove in a VPC in a
3315 # region is 64.
3316 # - The network endpoints that are attached to a backend of a backend
3317 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
3318 # - Traffic directed to the leader by a static route next hop will not be
3319 # redirected to a new leader by fast failover. Such traffic will only be
3320 # redirected once an haPolicy.leader update has taken effect. Only traffic
3321 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
3322 # fast failover.
3323 #
3324 #
3325 # haPolicy.fastIPMove can be set only at backend service creation time.
3326 # Once set, it cannot be updated.
3327 #
3328 # By default, fastIpMove is set to DISABLED.
3329 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
3330 # this service as the active endpoint (the leader) that receives all
3331 # traffic.
3332 #
3333 # When the leader changes, there is no connection draining to persist
3334 # existing connections on the old leader.
3335 #
3336 # You are responsible for selecting a suitable endpoint as the
3337 # leader. For example, preferring a healthy endpoint over unhealthy ones.
3338 # Note that this service does not track backend endpoint health, and
3339 # selects the configured leader unconditionally.
3340 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
3341 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
3342 # that the leader is attached to.
3343 #
3344 # The leader&#x27;s backendGroup must already be specified as a backend of
3345 # this backend service. Removing a backend that is designated as the
3346 # leader&#x27;s backendGroup is not permitted.
3347 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
3348 # designated as the leader.
3349 #
3350 # This network endpoint cannot be detached from the NEG specified in
3351 # the haPolicy.leader.backendGroup until the leader is updated with
3352 # another network endpoint, or the leader is removed from the haPolicy.
3353 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
3354 # instance must already be attached to the NEG specified in the
3355 # haPolicy.leader.backendGroup.
3356 #
3357 # The name must be 1-63 characters long, and comply with RFC1035.
3358 # Authorization requires the following IAM permission on the
3359 # specified resource instance: compute.instances.use
3360 },
3361 },
3362 },
3363 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
3364 # httpsHealthChecks (legacy) resource for health checking this backend
3365 # service. Not all backend services support legacy health checks. See
3366 # Load balancer guide. Currently, at most one health check can be
3367 # specified for each backend service. Backend services with
3368 # instance group or zonal NEG backends must have a health check unless
3369 # haPolicy is specified. Backend services with internet or serverless NEG
3370 # backends must not have a health check.
3371 #
3372 # healthChecks[] cannot be specified with haPolicy.
3373 &quot;A String&quot;,
3374 ],
3375 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
3376 # Not available for internal passthrough Network Load Balancers and external
3377 # passthrough Network Load Balancers.
3378 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
3379 # incoming requests.
3380 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
3381 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
3382 # for IAP.
3383 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
3384 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
3385 # Optional - If not provided, the name will be autogenerated by the
3386 # backend.
3387 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
3388 },
3389 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
3390 # For security reasons, this value cannot be retrieved via the API.
3391 # Instead, the SHA-256 hash of the value is returned in the
3392 # oauth2ClientSecretSha256 field.
3393 #
3394 # @InputOnly
3395 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
3396 },
3397 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3398 # defined by the server.
3399 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
3400 # from the client to the backend for proxyless gRPC).
3401 # The possible values are:
3402 #
3403 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
3404 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3405 # Group), regardless of traffic from the client to the proxy. Only IPv4
3406 # health checks are used to check the health of the backends. This is the
3407 # default setting.
3408 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
3409 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
3410 # address).
3411 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
3412 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3413 # Group), regardless of traffic from the client to the proxy. Only IPv6
3414 # health checks are used to check the health of the backends.
3415 #
3416 #
3417 #
3418 # This field is applicable to either:
3419 #
3420 # - Advanced global external Application Load Balancer (load balancing
3421 # scheme EXTERNAL_MANAGED),
3422 # - Regional external Application Load
3423 # Balancer,
3424 # - Internal proxy Network Load Balancer (load balancing
3425 # scheme INTERNAL_MANAGED),
3426 # - Regional internal Application Load
3427 # Balancer (load balancing scheme INTERNAL_MANAGED),
3428 # - Traffic
3429 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
3430 # INTERNAL_SELF_MANAGED).
3431 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
3432 # for backend services.
3433 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
3434 # created for one type of load balancer cannot be used with another.
3435 # For more information, refer toChoosing
3436 # a load balancer.
3437 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
3438 # preference. When you use localityLbPolicies, you must set at least one
3439 # value for either the localityLbPolicies[].policy or the
3440 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
3441 # value set in the localityLbPolicy field.
3442 #
3443 # For an example of how to use this field, seeDefine
3444 # a list of preferred policies.
3445 #
3446 # Caution: This field and its children are intended for use in a service mesh
3447 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
3448 # that have this configuration.
3449 { # Container for either a built-in LB policy supported by gRPC or Envoy or
3450 # a custom one implemented by the end user.
3451 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
3452 # deployed with the client.
3453 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
3454 # by a locally installed custom policy implementation.
3455 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
3456 #
3457 # The value should match the name of a custom implementation registered
3458 # on the gRPC clients. It should follow protocol buffer message naming
3459 # conventions and include the full path (for example,
3460 # myorg.CustomLbPolicy). The maximum length is 256 characters.
3461 #
3462 # Do not specify the same custom policy more than once for a
3463 # backend. If you do, the configuration is rejected.
3464 #
3465 # For an example of how to use this field, seeUse
3466 # a custom policy.
3467 },
3468 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
3469 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
3470 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
3471 # about these values, see the description of localityLbPolicy.
3472 #
3473 # Do not specify the same policy more than once for a
3474 # backend. If you do, the configuration is rejected.
3475 },
3476 },
3477 ],
3478 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
3479 # possible values are:
3480 #
3481 # - ROUND_ROBIN: This is a simple policy in which each healthy
3482 # backend is selected in round robin order. This is the default.
3483 # - LEAST_REQUEST: An O(1) algorithm which
3484 # selects two random healthy hosts and picks the host which has fewer active
3485 # requests.
3486 # - RING_HASH: The ring/modulo hash load balancer implements
3487 # consistent hashing to backends. The algorithm has the property that the
3488 # addition/removal of a host from a set of N hosts only affects 1/N of the
3489 # requests.
3490 # - RANDOM: The load balancer selects a random healthy
3491 # host.
3492 # - ORIGINAL_DESTINATION: Backend host is selected
3493 # based on the client connection metadata, i.e., connections are opened to
3494 # the same address as the destination address of the incoming connection
3495 # before the connection was redirected to the load balancer.
3496 # - MAGLEV: used as a drop in replacement for the ring hash
3497 # load balancer. Maglev is not as stable as ring hash but has faster table
3498 # lookup build times and host selection times. For more information about
3499 # Maglev, see Maglev:
3500 # A Fast and Reliable Software Network Load Balancer.
3501 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
3502 # Load Balancing using weights computed from Backend reported Custom Metrics.
3503 # If set, the Backend Service responses are expected to contain non-standard
3504 # HTTP response header field Endpoint-Load-Metrics. The reported
3505 # metrics to use for computing the weights are specified via thecustomMetrics field.
3506 #
3507 # This field is applicable to either:
3508 # - A regional backend service with the service protocol set to HTTP,
3509 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3510 # INTERNAL_MANAGED.
3511 # - A global backend service with the
3512 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
3513 # EXTERNAL_MANAGED.
3514 #
3515 #
3516 # If sessionAffinity is not configured—that is, if session
3517 # affinity remains at the default value of NONE—then the
3518 # default value for localityLbPolicy
3519 # is ROUND_ROBIN. If session affinity is set to a value other
3520 # than NONE,
3521 # then the default value for localityLbPolicy isMAGLEV.
3522 #
3523 # Only ROUND_ROBIN and RING_HASH are supported
3524 # when the backend service is referenced by a URL map that is bound to
3525 # target gRPC proxy that has validateForProxyless field set to true.
3526 #
3527 # localityLbPolicy cannot be specified with haPolicy.
3528 &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
3529 # by this backend service. If logging is enabled, logs will be exported to
3530 # Stackdriver.
3531 # backend service.
3532 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
3533 # traffic served by this backend service. The default value is false.
3534 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
3535 { # Determines which HTTP headers will be logged to Stackdriver.
3536 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3537 },
3538 ],
3539 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
3540 { # Determines which HTTP headers will be logged to Stackdriver.
3541 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3542 },
3543 ],
3544 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
3545 # This field can only be specified if logging is enabled for this backend
3546 # service. Configures whether all, none or a subset of optional fields
3547 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3548 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3549 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
3550 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
3551 # of optional fields you want to include in the logs. For example:
3552 # serverInstance, serverGkeDetails.cluster,
3553 # serverGkeDetails.pod.podNamespace
3554 &quot;A String&quot;,
3555 ],
3556 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
3557 # service. Configures whether all, none or a subset of optional fields
3558 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3559 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3560 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
3561 # service. The value of the field must be in [0, 1]. This configures the
3562 # sampling rate of requests to the load balancer where 1.0 means all logged
3563 # requests are reported and 0.0 means no logged requests are reported. The
3564 # default value is 1.0.
3565 },
3566 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
3567 # service. Duration is computed from the beginning of the stream until the
3568 # response has been completely processed, including all retries. A stream
3569 # that does not complete in this duration is closed.
3570 #
3571 # If not specified, there will be no timeout limit, i.e. the maximum
3572 # duration is infinite.
3573 #
3574 # This value can be overridden in the PathMatcher configuration of the
3575 # UrlMap that references this backend service.
3576 #
3577 # This field is only allowed when the loadBalancingScheme of
3578 # the backend service is INTERNAL_SELF_MANAGED.
3579 # as a count of seconds and fractions of seconds at nanosecond
3580 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3581 # or &quot;month&quot;. Range is approximately 10,000 years.
3582 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3583 # Durations less than one second are represented with a 0
3584 # `seconds` field and a positive `nanos` field. Must be from 0
3585 # to 999,999,999 inclusive.
3586 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3587 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3588 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3589 },
3590 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
3591 # controller and read by the backend RCTH
3592 &quot;a_key&quot;: &quot;A String&quot;,
3593 },
3594 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3595 # The name must be 1-63 characters long, and comply withRFC1035.
3596 # Specifically, the name must be 1-63 characters long and match the regular
3597 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3598 # character must be a lowercase letter, and all following characters must
3599 # be a dash, lowercase letter, or digit, except the last character, which
3600 # cannot be a dash.
3601 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
3602 #
3603 # This field must be set for Internal Passthrough Network Load Balancers when
3604 # the haPolicy is enabled, and for External Passthrough Network Load
3605 # Balancers when the haPolicy fastIpMove is enabled.
3606 #
3607 # 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.
3608 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
3609 # Load Balancers.
3610 #
3611 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
3612 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
3613 # endpoints in the local zone.
3614 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
3615 # possible values are:
3616 #
3617 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
3618 # is disabled. The load balancer distributes new connections to all
3619 # healthy backend endpoints across all zones.
3620 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
3621 # enabled. The load balancer distributes new connections to all healthy
3622 # backend endpoints in the local zone only. If there are no healthy
3623 # backend endpoints in the local zone, the load balancer distributes
3624 # new connections to all backend endpoints in the local zone.
3625 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
3626 # enabled. The load balancer distributes new connections to all healthy
3627 # backend endpoints in the local zone only. If there aren&#x27;t enough
3628 # healthy backend endpoints in the local zone, the load balancer
3629 # distributes new connections to all healthy backend endpoints across all
3630 # zones.
3631 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
3632 # of healthy backend endpoints in a zone to the count of backend
3633 # endpoints in that same zone is equal to or above this threshold, the
3634 # load balancer distributes new connections to all healthy endpoints in
3635 # the local zone only. When the ratio of the count of healthy backend
3636 # endpoints in a zone to the count of backend endpoints in that same
3637 # zone is below this threshold, the load balancer distributes all new
3638 # connections to all healthy endpoints across all zones.
3639 },
3640 },
3641 &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.
3642 # the backend service.
3643 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
3644 # service.
3645 },
3646 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
3647 # load balancing pool of each individual proxy instance that processes the
3648 # traffic for the given backend service. If not set, this feature is
3649 # considered disabled.
3650 #
3651 # Results of the outlier detection algorithm (ejection of endpoints from the
3652 # load balancing pool and returning them back to the pool) are executed
3653 # independently by each proxy instance of the load balancer. In most cases,
3654 # more than one proxy instance handles the traffic received by a backend
3655 # service. Thus, it is possible that an unhealthy endpoint is detected and
3656 # ejected by only some of the proxies, and while this happens, other proxies
3657 # may continue to send requests to the same unhealthy endpoint until they
3658 # detect and eject the unhealthy endpoint.
3659 #
3660 # Applicable backend endpoints can be:
3661 #
3662 # - VM instances in an Instance Group
3663 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
3664 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
3665 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
3666 # Functions Services
3667 # - Private Service Connect NEGs, that resolve to
3668 # Google-managed regional API endpoints or managed services published using
3669 # Private Service Connect
3670 #
3671 #
3672 #
3673 # Applicable backend service types can be:
3674 #
3675 # - A global backend service with the loadBalancingScheme set to
3676 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
3677 # - A regional backend
3678 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
3679 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
3680 # supported for Serverless NEGs.
3681 #
3682 #
3683 #
3684 # Not supported when the backend service is referenced by a URL map that is
3685 # bound to target gRPC proxy that has validateForProxyless field set to true.
3686 # pool for the backend service.
3687 &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
3688 # or 30s.
3689 #
3690 # After a backend endpoint is returned back to the load balancing pool, it
3691 # can be ejected again in another ejection analysis. Thus, the total ejection
3692 # time is equal to the base ejection time multiplied by the number of times
3693 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
3694 # as a count of seconds and fractions of seconds at nanosecond
3695 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3696 # or &quot;month&quot;. Range is approximately 10,000 years.
3697 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3698 # Durations less than one second are represented with a 0
3699 # `seconds` field and a positive `nanos` field. Must be from 0
3700 # to 999,999,999 inclusive.
3701 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3702 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3703 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3704 },
3705 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
3706 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
3707 # return code qualifies as an error. Defaults to 5.
3708 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
3709 # connection errors that are mapped to one of those status codes) before a
3710 # consecutive gateway failure ejection occurs. Defaults to 3.
3711 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3712 # outlier status is detected through consecutive 5xx. This setting can be
3713 # used to disable ejection or to ramp it up slowly. Defaults to 0.
3714 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3715 # outlier status is detected through consecutive gateway failures. This
3716 # setting can be used to disable ejection or to ramp it up slowly. Defaults
3717 # to 100.
3718 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3719 # outlier status is detected through success rate statistics. This setting
3720 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
3721 #
3722 # Not supported when the backend service uses Serverless NEG.
3723 &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
3724 # ejections and backend endpoints being returned to service. The interval is
3725 # equal to the number of seconds as defined in
3726 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
3727 # in outlierDetection.interval.nanos. Defaults to 1 second.
3728 # as a count of seconds and fractions of seconds at nanosecond
3729 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3730 # or &quot;month&quot;. Range is approximately 10,000 years.
3731 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3732 # Durations less than one second are represented with a 0
3733 # `seconds` field and a positive `nanos` field. Must be from 0
3734 # to 999,999,999 inclusive.
3735 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3736 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3737 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3738 },
3739 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
3740 # backend service that can be ejected if the ejection conditions are met.
3741 # Defaults to 50%.
3742 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
3743 # enough request volume to detect success rate outliers. If the number of
3744 # backend endpoints is fewer than this setting, outlier detection via success
3745 # rate statistics is not performed for any backend endpoint in the load
3746 # balancing pool. Defaults to 5.
3747 #
3748 # Not supported when the backend service uses Serverless NEG.
3749 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
3750 # (as defined by the interval duration above) to include this backend
3751 # endpoint in success rate based outlier detection. If the volume is lower
3752 # than this setting, outlier detection via success rate statistics is not
3753 # performed for that backend endpoint. Defaults to 100.
3754 #
3755 # Not supported when the backend service uses Serverless NEG.
3756 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
3757 # outlier ejection. The ejection threshold is the difference between the mean
3758 # success rate, and the product of this factor and the standard deviation of
3759 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
3760 # is divided by a thousand to get a double. That is, if the desired factor
3761 # is 1.9, the runtime value should be 1900. Defaults to 1900.
3762 #
3763 # Not supported when the backend service uses Serverless NEG.
3764 },
3765 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3766 # as part of resource payload.
3767 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3768 # Tag keys and values have the same definition as resource
3769 # manager tags. The field is allowed for INSERT
3770 # only. The keys/values to set on the resource should be specified in
3771 # either ID { : } or Namespaced format
3772 # { : }.
3773 # For example the following are valid inputs:
3774 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3775 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3776 # Note:
3777 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3778 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3779 &quot;a_key&quot;: &quot;A String&quot;,
3780 },
3781 },
3782 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
3783 # the backend. The default value is 80.
3784 # For internal passthrough Network Load Balancers and external passthrough
3785 # Network Load Balancers, omit port.
3786 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
3787 # communication to the backend VMs in that group. The
3788 # named port must be [defined on each backend instance
3789 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
3790 # This parameter has no meaning if the backends are NEGs. For internal
3791 # passthrough Network Load Balancers and external passthrough Network Load
3792 # Balancers, omit port_name.
3793 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
3794 # with backends.
3795 #
3796 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
3797 # depending on the chosen load balancer or Traffic Director configuration.
3798 # Refer to the documentation for the load balancers or for Traffic Director
3799 # for more information.
3800 #
3801 # Must be set to GRPC when the backend service is referenced by a URL map
3802 # that is bound to target gRPC proxy.
3803 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
3804 # resides. This field is not applicable to global backend services.
3805 # You must specify this field as part of the HTTP request URL. It is
3806 # not settable as a field in the request body.
3807 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
3808 # backend service.
3809 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
3810 # service. This field is applicable to a global backend service with the
3811 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3812 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
3813 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
3814 # be accepted on backends, and if authenticated, which method/certificate
3815 # will set the request principal.
3816 # request principal.
3817 # The authentication settings for the backend service.
3818 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
3819 # Similar to peers, these will be evaluated in order the first valid one
3820 # will be used to set origin identity. If none of these methods pass, the
3821 # request will be rejected with authentication failed error (401). Leave the
3822 # list empty if origin authentication is not required.
3823 { # [Deprecated] Configuration for the origin authentication method.
3824 # Configuration for the origin authentication method.
3825 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
3826 # JWT configuration for origin authentication.
3827 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
3828 # will be accepted if audiences is empty.
3829 # Examples: bookstore_android.apps.googleusercontent.com,
3830 # bookstore_web.apps.googleusercontent.com
3831 &quot;A String&quot;,
3832 ],
3833 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
3834 # email address.
3835 # Examples: https://securetoken.google.com,
3836 # [email protected]
3837 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
3838 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
3839 # request. If no explicit location is specified, the following default
3840 # locations are tried in order:
3841 #
3842 # 1. The Authorization header using the Bearer schema. See `here
3843 # `_. Example:
3844 #
3845 # Authorization: Bearer .
3846 #
3847 # 2. `access_token` query parameter. See `this
3848 # `_
3849 #
3850 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
3851 # from the locations its issuer specified or from the default locations.
3852 #
3853 # This field is set if JWT is sent in a request header. This field specifies
3854 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
3855 # header format will be x-goog-iap-jwt-assertion: .
3856 { # [Deprecated] This message specifies a header location to extract JWT token.
3857 # This message specifies a header location to extract JWT token.
3858 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
3859 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
3860 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
3861 # with a space at the end.
3862 },
3863 ],
3864 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
3865 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
3866 # JWT format in the query parameter is /path?jwt_token=.
3867 &quot;A String&quot;,
3868 ],
3869 },
3870 },
3871 ],
3872 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
3873 # They will be evaluated in order the first valid one will be used to set
3874 # peer identity. If none of these methods pass, the request will be rejected
3875 # with authentication failed error (401). Leave the list empty if peer
3876 # authentication is not required.
3877 { # [Deprecated] Configuration for the peer authentication method.
3878 # Configuration for the peer authentication method.
3879 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
3880 # Configuration for the mutual Tls mode for peer authentication.
3881 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
3882 # field can be set to one of the following:
3883 # STRICT: Client certificate must be presented, connection is in TLS.
3884 # PERMISSIVE: Client certificate can be omitted, connection can be either
3885 # plaintext or TLS.
3886 },
3887 },
3888 ],
3889 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
3890 # Default value is USE_PEER. If peer (or origin) identity is not available,
3891 # either because peer/origin authentication is not defined, or failed,
3892 # principal will be left unset. In other words, binding rule does not affect
3893 # the decision to accept or reject request. This field can be set to one of
3894 # the following:
3895 # USE_PEER: Principal will be set to the identity from peer authentication.
3896 # USE_ORIGIN: Principal will be set to the identity from origin
3897 # authentication.
3898 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
3899 # identity information.
3900 # The TLS settings for the client or server.
3901 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
3902 # certificate.
3903 # Defines the mechanism to obtain the client or server certificate.
3904 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
3905 # applicable only if tlsCertificateSource is set to USE_PATH.
3906 # The paths to the mounted TLS Certificates and private key.
3907 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
3908 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
3909 },
3910 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
3911 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
3912 # is applicable only if tlsCertificateSource is set to USE_SDS.
3913 # The configuration to access the SDS server.
3914 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
3915 # gRPC config to access the SDS server.
3916 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
3917 # gRPC call credentials to access the SDS server.
3918 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
3919 # This field can be set to one of the following:
3920 #
3921 # - GCE_VM: The local GCE VM service account credentials are used to access
3922 # the SDS server.
3923 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
3924 # SDS server.
3925 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
3926 # FROM_PLUGIN.
3927 # Custom authenticator credentials.
3928 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
3929 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
3930 # plugin.
3931 },
3932 },
3933 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
3934 # gRPC channel credentials to access the SDS server.
3935 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
3936 # The paths to the mounted TLS Certificates and private key.
3937 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
3938 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
3939 },
3940 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
3941 # to one of the following:
3942 # CERTIFICATES: Use TLS certificates to access the SDS server.
3943 # GCE_VM: Use local GCE VM credentials to access the SDS server.
3944 },
3945 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
3946 },
3947 },
3948 },
3949 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
3950 # validate the client/server certificate. If omitted, the proxy will not
3951 # validate the server or client certificate.
3952 # certificate to validate the client/server certificate.
3953 # validate the client/server certificate.
3954 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
3955 # client or server certificate.
3956 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
3957 # is applicable only if tlsCertificateSource is set to USE_SDS.
3958 # The configuration to access the SDS server.
3959 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
3960 # gRPC config to access the SDS server.
3961 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
3962 # gRPC call credentials to access the SDS server.
3963 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
3964 # This field can be set to one of the following:
3965 #
3966 # - GCE_VM: The local GCE VM service account credentials are used to access
3967 # the SDS server.
3968 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
3969 # SDS server.
3970 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
3971 # FROM_PLUGIN.
3972 # Custom authenticator credentials.
3973 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
3974 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
3975 # plugin.
3976 },
3977 },
3978 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
3979 # gRPC channel credentials to access the SDS server.
3980 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
3981 # The paths to the mounted TLS Certificates and private key.
3982 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
3983 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
3984 },
3985 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
3986 # to one of the following:
3987 # CERTIFICATES: Use TLS certificates to access the SDS server.
3988 # GCE_VM: Use local GCE VM credentials to access the SDS server.
3989 },
3990 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
3991 },
3992 },
3993 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
3994 },
3995 },
3996 },
3997 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
3998 # (RBAC) config.
3999 # Authorization config defines the Role Based Access Control (RBAC) config.
4000 # method-level access control for a service.
4001 # control for a service.
4002 &quot;policies&quot;: [ # List of RbacPolicies.
4003 {
4004 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
4005 &quot;permissions&quot;: [ # The list of permissions.
4006 { # [Deprecated] All fields defined in a permission are ANDed.
4007 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
4008 { # Custom constraint that specifies a key and a list of allowed values for
4009 # Istio attributes.
4010 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
4011 &quot;values&quot;: [ # A list of allowed values.
4012 &quot;A String&quot;,
4013 ],
4014 },
4015 ],
4016 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
4017 # applies to. Exact match, prefix match, and suffix match are supported.
4018 &quot;A String&quot;,
4019 ],
4020 &quot;methods&quot;: [ # HTTP method.
4021 &quot;A String&quot;,
4022 ],
4023 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
4024 &quot;A String&quot;,
4025 ],
4026 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
4027 &quot;A String&quot;,
4028 ],
4029 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
4030 &quot;A String&quot;,
4031 ],
4032 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
4033 &quot;A String&quot;,
4034 ],
4035 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
4036 # Exact match, prefix match, and suffix match are supported.
4037 &quot;A String&quot;,
4038 ],
4039 &quot;ports&quot;: [ # Port names or numbers.
4040 &quot;A String&quot;,
4041 ],
4042 },
4043 ],
4044 &quot;principals&quot;: [ # The list of principals.
4045 { # [Deprecated] All fields defined in a principal are ANDed.
4046 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
4047 &quot;groups&quot;: [ # The groups the principal belongs to.
4048 # Exact match, prefix match, and suffix match are supported.
4049 &quot;A String&quot;,
4050 ],
4051 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
4052 &quot;A String&quot;,
4053 ],
4054 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
4055 &quot;A String&quot;,
4056 ],
4057 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
4058 &quot;A String&quot;,
4059 ],
4060 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
4061 &quot;A String&quot;,
4062 ],
4063 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
4064 &quot;A String&quot;,
4065 ],
4066 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
4067 &quot;A String&quot;,
4068 ],
4069 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
4070 # suffix match are supported for values. For example,
4071 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
4072 &quot;a_key&quot;: &quot;A String&quot;,
4073 },
4074 &quot;users&quot;: [ # The user names/IDs or service accounts.
4075 # Exact match, prefix match, and suffix match are supported.
4076 &quot;A String&quot;,
4077 ],
4078 },
4079 ],
4080 },
4081 ],
4082 },
4083 &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
4084 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
4085 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
4086 # private storage buckets that support Signature Version 4 for authentication.
4087 # The service name for generating the authentication header will always default
4088 # to &#x27;s3&#x27;.
4089 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
4090 # creating a backend that uses AWS v4 signature authentication, but will not
4091 # be returned as part of the configuration when queried with a REST API GET
4092 # request.
4093 #
4094 # @InputOnly
4095 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
4096 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
4097 # keep track of different iterations of your access key.
4098 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
4099 # the name of the region your cloud uses to host your origin. For example,
4100 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
4101 },
4102 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
4103 # that describes how clients should authenticate with this service&#x27;s
4104 # backends.
4105 #
4106 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
4107 # to INTERNAL_SELF_MANAGED.
4108 #
4109 # If left blank, communications are not encrypted.
4110 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
4111 # originating from the backend service.
4112 # the backend service.
4113 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
4114 # identity information. This field is only applicable when mode is set to
4115 # MUTUAL.
4116 # The TLS settings for the client or server.
4117 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
4118 # certificate.
4119 # Defines the mechanism to obtain the client or server certificate.
4120 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
4121 # applicable only if tlsCertificateSource is set to USE_PATH.
4122 # The paths to the mounted TLS Certificates and private key.
4123 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4124 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4125 },
4126 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
4127 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
4128 # is applicable only if tlsCertificateSource is set to USE_SDS.
4129 # The configuration to access the SDS server.
4130 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
4131 # gRPC config to access the SDS server.
4132 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
4133 # gRPC call credentials to access the SDS server.
4134 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
4135 # This field can be set to one of the following:
4136 #
4137 # - GCE_VM: The local GCE VM service account credentials are used to access
4138 # the SDS server.
4139 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
4140 # SDS server.
4141 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
4142 # FROM_PLUGIN.
4143 # Custom authenticator credentials.
4144 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
4145 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
4146 # plugin.
4147 },
4148 },
4149 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
4150 # gRPC channel credentials to access the SDS server.
4151 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
4152 # The paths to the mounted TLS Certificates and private key.
4153 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4154 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4155 },
4156 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
4157 # to one of the following:
4158 # CERTIFICATES: Use TLS certificates to access the SDS server.
4159 # GCE_VM: Use local GCE VM credentials to access the SDS server.
4160 },
4161 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
4162 },
4163 },
4164 },
4165 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
4166 # validate the client/server certificate. If omitted, the proxy will not
4167 # validate the server or client certificate.
4168 # certificate to validate the client/server certificate.
4169 # validate the client/server certificate.
4170 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
4171 # client or server certificate.
4172 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
4173 # is applicable only if tlsCertificateSource is set to USE_SDS.
4174 # The configuration to access the SDS server.
4175 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
4176 # gRPC config to access the SDS server.
4177 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
4178 # gRPC call credentials to access the SDS server.
4179 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
4180 # This field can be set to one of the following:
4181 #
4182 # - GCE_VM: The local GCE VM service account credentials are used to access
4183 # the SDS server.
4184 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
4185 # SDS server.
4186 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
4187 # FROM_PLUGIN.
4188 # Custom authenticator credentials.
4189 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
4190 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
4191 # plugin.
4192 },
4193 },
4194 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
4195 # gRPC channel credentials to access the SDS server.
4196 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
4197 # The paths to the mounted TLS Certificates and private key.
4198 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4199 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4200 },
4201 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
4202 # to one of the following:
4203 # CERTIFICATES: Use TLS certificates to access the SDS server.
4204 # GCE_VM: Use local GCE VM credentials to access the SDS server.
4205 },
4206 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
4207 },
4208 },
4209 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
4210 },
4211 },
4212 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
4213 # The value of this field determines how TLS is enforced. This can be set
4214 # to one of the following values: DISABLE: Do not setup a TLS connection to
4215 # the backends.
4216 # SIMPLE: Originate a TLS connection to the backends.
4217 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
4218 # client certificates for authentication.
4219 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
4220 # applicable only when mode is SIMPLE or MUTUAL.
4221 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
4222 # certificate.If specified,
4223 # the proxy will verify that the server certificate&#x27;s subject alt name
4224 # matches one of the specified values. This field is applicable only when
4225 # mode is SIMPLE or MUTUAL.
4226 &quot;A String&quot;,
4227 ],
4228 },
4229 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
4230 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
4231 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
4232 # specified values, the communication continues. Otherwise, it fails. This
4233 # additional check enables the client to verify that the server is authorized
4234 # to run the requested service.
4235 #
4236 # Note that the contents of the server
4237 # certificate&#x27;s subjectAltName field are configured by the
4238 # Public Key Infrastructure which provisions server identities.
4239 #
4240 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
4241 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
4242 # mode).
4243 &quot;A String&quot;,
4244 ],
4245 },
4246 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4247 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4248 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
4249 #
4250 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
4251 # If set, lists of backends and health checks must be both empty.
4252 &quot;A String&quot;,
4253 ],
4254 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
4255 #
4256 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
4257 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
4258 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
4259 #
4260 # Only NONE and HEADER_FIELD are supported
4261 # when the backend service is referenced by a URL map that is bound to
4262 # target gRPC proxy that has validateForProxyless field set to true.
4263 #
4264 # For more details, see:
4265 # [Session
4266 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
4267 #
4268 # sessionAffinity cannot be specified with haPolicy.
4269 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
4270 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
4271 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
4272 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
4273 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
4274 # as a count of seconds and fractions of seconds at nanosecond
4275 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4276 # or &quot;month&quot;. Range is approximately 10,000 years.
4277 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4278 # Durations less than one second are represented with a 0
4279 # `seconds` field and a positive `nanos` field. Must be from 0
4280 # to 999,999,999 inclusive.
4281 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4282 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4283 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4284 },
4285 },
4286 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
4287 # Currently this is applicable only for Internal TCP/UDP load balancing,
4288 # Internal HTTP(S) load balancing and Traffic Director.
4289 &quot;policy&quot;: &quot;A String&quot;,
4290 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
4291 # each service mesh client.
4292 #
4293 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
4294 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
4295 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
4296 # `INTERNAL_SELF_MANAGED`.
4297 #
4298 # `subset_size` is optional for Internal HTTP(S) load balancing
4299 # and required for Traffic Director.
4300 #
4301 # If you do not provide this value, Cloud Load Balancing will calculate it
4302 # dynamically to optimize the number of proxies/clients visible to each
4303 # backend and vice versa.
4304 #
4305 # Must be greater than 0. If `subset_size` is larger than the number of
4306 # backends/endpoints, then subsetting is disabled.
4307 },
4308 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
4309 # type of load balancer. For more information see,
4310 # Backend service settings.
4311 # The default is 30 seconds.
4312 # The full range of timeout values allowed goes from 1
4313 # through 2,147,483,647 seconds.
4314 #
4315 # This value can be overridden in the PathMatcher configuration of the
4316 # UrlMap that references this backend service.
4317 #
4318 # Not supported when the backend service is referenced by a URL map that is
4319 # bound to target gRPC proxy that has validateForProxyless field set to true.
4320 # Instead, use maxStreamDuration.
4321 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
4322 # when the backend protocol is SSL, HTTPS or HTTP2.
4323 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
4324 # networksecurity.googleapis.com namespace. Can be used in authenticating
4325 # TLS connections to the backend, as specified by the authenticationMode
4326 # field. Can only be specified if authenticationMode is not NONE.
4327 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
4328 #
4329 #
4330 # Use this property to configure the load balancer back-end to use
4331 # certificates and roots of trust provisioned by the Managed Workload
4332 # Identity system.
4333 #
4334 # The `identity` property is the
4335 # fully-specified SPIFFE ID to use in the SVID presented by the Load
4336 # Balancer Workload.
4337 #
4338 # The SPIFFE ID must be a resource starting with the
4339 # `trustDomain` property value, followed by the path to the Managed
4340 # Workload Identity.
4341 #
4342 # Supported SPIFFE ID format:
4343 #
4344 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
4345 #
4346 #
4347 # The Trust Domain within the Managed Identity must refer to a valid
4348 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
4349 # will be inherited from the Workload Identity Pool.
4350 #
4351 # Restrictions:
4352 #
4353 # - If you set the `identity` property, you cannot manually set
4354 # the following fields:
4355 # - tlsSettings.sni
4356 # - tlsSettings.subjectAltNames
4357 # - tlsSettings.authenticationConfig
4358 #
4359 #
4360 # When defining a `identity` for a RegionBackendServices, the
4361 # corresponding Workload Identity Pool must have a ca_pool
4362 # configured in the same region.
4363 #
4364 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
4365 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
4366 # balancer sends this string as the SNI hostname in the TLS connection to
4367 # the backend, and requires that this string match a Subject Alternative
4368 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
4369 # NEG backend, if the SNI is specified here, the load balancer uses it
4370 # regardless of whether the Regional Internet NEG is specified with FQDN or
4371 # IP address and port. When both sni and subjectAltNames[] are specified,
4372 # the load balancer matches the backend certificate&#x27;s SAN only to
4373 # subjectAltNames[].
4374 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
4375 # verifies during a TLS handshake with the backend. When the server
4376 # presents its X.509 certificate to the Load Balancer, the Load Balancer
4377 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
4378 # match one of the subjectAltNames in the list. This field is limited to 5
4379 # entries. When both sni and subjectAltNames[] are specified, the load
4380 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
4381 { # A Subject Alternative Name that the load balancer matches against the SAN
4382 # field in the TLS certificate provided by the backend, specified as either
4383 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
4384 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
4385 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
4386 },
4387 ],
4388 },
4389 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
4390 {
4391 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
4392 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
4393 # and ForwardingRule.
4394 },
4395 ],
4396 }
4397
4398 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4399 that if you must retry your request, the server will know to ignore the
4400 request if it has already been completed.
4401
4402 For example, consider a situation where you make an initial request and
4403 the request times out. If you make the request again with the same
4404 request ID, the server can check if original operation with the same
4405 request ID was received, and if so, will ignore the second request. This
4406 prevents clients from accidentally creating duplicate commitments.
4407
4408 The request ID must be
4409 a valid UUID with the exception that zero UUID is not supported
4410 (00000000-0000-0000-0000-000000000000).
4411 x__xgafv: string, V1 error format.
4412 Allowed values
4413 1 - v1 error format
4414 2 - v2 error format
4415
4416 Returns:
4417 An object of the form:
4418
4419 { # Represents an Operation resource.
4420 #
4421 # Google Compute Engine has three Operation resources:
4422 #
4423 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4424 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4425 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4426 #
4427 # You can use an operation resource to manage asynchronous API requests.
4428 # For more information, readHandling
4429 # API responses.
4430 #
4431 # Operations can be global, regional or zonal.
4432 #
4433 # - For global operations, use the `globalOperations`
4434 # resource.
4435 # - For regional operations, use the
4436 # `regionOperations` resource.
4437 # - For zonal operations, use
4438 # the `zoneOperations` resource.
4439 #
4440 #
4441 #
4442 # For more information, read
4443 # Global, Regional, and Zonal Resources.
4444 #
4445 # Note that completed Operation resources have a limited
4446 # retention period.
4447 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4448 # Not present otherwise.
4449 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4450 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4451 # set when the operation is created.
4452 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4453 # text format.
4454 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4455 # this field will be populated.
4456 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4457 # operation.
4458 {
4459 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4460 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4461 # details. There is a set of defined message types to use for providing
4462 # details.The syntax depends on the error code. For example,
4463 # QuotaExceededInfo will have details when the error code is
4464 # QUOTA_EXCEEDED.
4465 {
4466 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4467 #
4468 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4469 # is not enabled:
4470 #
4471 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4472 # &quot;domain&quot;: &quot;googleapis.com&quot;
4473 # &quot;metadata&quot;: {
4474 # &quot;resource&quot;: &quot;projects/123&quot;,
4475 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4476 # }
4477 # }
4478 #
4479 # This response indicates that the pubsub.googleapis.com API is not enabled.
4480 #
4481 # Example of an error that is returned when attempting to create a Spanner
4482 # instance in a region that is out of stock:
4483 #
4484 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4485 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4486 # &quot;metadata&quot;: {
4487 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4488 # }
4489 # }
4490 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4491 # is typically the registered service name of the tool or product that
4492 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4493 # generated by some common infrastructure, the error domain must be a
4494 # globally unique value that identifies the infrastructure. For Google API
4495 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4496 &quot;metadatas&quot;: { # Additional structured details about this error.
4497 #
4498 # Keys must match a regular expression of `a-z+` but should
4499 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4500 # length. When identifying the current value of an exceeded limit, the units
4501 # should be contained in the key, not the value. For example, rather than
4502 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4503 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4504 # instances that can be created in a single (batch) request.
4505 &quot;a_key&quot;: &quot;A String&quot;,
4506 },
4507 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4508 # proximate cause of the error. Error reasons are unique within a particular
4509 # domain of errors. This should be at most 63 characters and match a
4510 # regular expression of `A-Z+[A-Z0-9]`, which represents
4511 # UPPER_SNAKE_CASE.
4512 },
4513 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4514 #
4515 # For example, if a quota check failed with an error indicating the calling
4516 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4517 # directly to the right place in the developer console to flip the bit.
4518 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4519 { # Describes a URL link.
4520 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4521 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4522 },
4523 ],
4524 },
4525 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4526 # which can be attached to an RPC error.
4527 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4528 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4529 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4530 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4531 },
4532 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4533 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4534 &quot;a_key&quot;: &quot;A String&quot;,
4535 },
4536 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4537 # type or metric.
4538 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4539 # or metric.
4540 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4541 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4542 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4543 },
4544 },
4545 ],
4546 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4547 # This property is optional.
4548 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4549 },
4550 ],
4551 },
4552 &quot;getVersionOperationMetadata&quot;: {
4553 &quot;inlineSbomInfo&quot;: {
4554 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4555 # appropriate identifiers.
4556 &quot;a_key&quot;: &quot;A String&quot;,
4557 },
4558 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4559 # identifiers.
4560 &quot;a_key&quot;: &quot;A String&quot;,
4561 },
4562 },
4563 },
4564 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4565 # message that was returned, such as `NOT FOUND`.
4566 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4567 # status code that was returned. For example, a `404` means the
4568 # resource was not found.
4569 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4570 # defined by the server.
4571 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4572 # This value is inRFC3339
4573 # text format.
4574 &quot;instancesBulkInsertOperationMetadata&quot;: {
4575 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4576 # Example key: zones/us-central1-a
4577 &quot;a_key&quot;: {
4578 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4579 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4580 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4581 # error.
4582 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4583 # if the flow is rolling forward or rolling back.
4584 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4585 },
4586 },
4587 },
4588 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4589 # Operation resources.
4590 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4591 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4592 # group of operations results from a `bulkInsert` API request.
4593 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4594 # `update`, or `delete`, and so on.
4595 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4596 # There is no requirement that this be linear or support any granularity of
4597 # operations. This should not be used to guess when the operation will be
4598 # complete. This number should monotonically increase as the operation
4599 # progresses.
4600 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4601 # applicable when performing regional operations.
4602 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4603 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4604 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4605 # this field will contain information on all underlying zonal actions and
4606 # their state.
4607 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4608 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4609 # Example key: zones/us-central1-a
4610 &quot;a_key&quot;: {
4611 &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
4612 # populated.
4613 # different programming environments, including REST APIs and RPC APIs. It is
4614 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4615 # three pieces of data: error code, error message, and error details.
4616 #
4617 # You can find out more about this error model and how to work with it in the
4618 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4619 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4620 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4621 # message types for APIs to use.
4622 {
4623 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4624 },
4625 ],
4626 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4627 # user-facing error message should be localized and sent in the
4628 # google.rpc.Status.details field, or localized by the client.
4629 },
4630 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4631 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4632 },
4633 },
4634 },
4635 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4636 # This value is inRFC3339
4637 # text format.
4638 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4639 # following:
4640 # `PENDING`, `RUNNING`, or `DONE`.
4641 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4642 # operation.
4643 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4644 # of the target resource.
4645 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4646 # operations related to creating a snapshot, this points to the disk
4647 # that the snapshot was created from.
4648 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4649 # `[email protected]` or
4650 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4651 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4652 # operation, this field will be populated.
4653 {
4654 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4655 # Engine returns NO_RESULTS_ON_PAGE if there
4656 # are no results in the response.
4657 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4658 # value format. For example:
4659 #
4660 # &quot;data&quot;: [
4661 # {
4662 # &quot;key&quot;: &quot;scope&quot;,
4663 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4664 # }
4665 {
4666 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4667 # returned. For example, for warnings where there are no results in a list
4668 # request for a particular zone, this key might be scope and
4669 # the key value might be the zone name. Other examples might be a key
4670 # indicating a deprecated resource and a suggested replacement, or a
4671 # warning about invalid network settings (for example, if an instance
4672 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4673 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4674 },
4675 ],
4676 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4677 },
4678 ],
4679 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4680 # applicable when performing per-zone operations.
4681 }</pre>
4682 </div>
4683
4684 <div class="method">
4685 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4686 <pre>Retrieves the list of regional BackendService resources available to the
4687 specified project in the given region.
4688
4689 Args:
4690 project: string, Project ID for this request. (required)
4691 region: string, Name of the region scoping this request. (required)
4692 filter: string, A filter expression that filters resources listed in the response. Most
4693 Compute resources support two types of filter expressions:
4694 expressions that support regular expressions and expressions that follow
4695 API improvement proposal AIP-160.
4696 These two types of filter expressions cannot be mixed in one request.
4697
4698 If you want to use AIP-160, your expression must specify the field name, an
4699 operator, and the value that you want to use for filtering. The value
4700 must be a string, a number, or a boolean. The operator
4701 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4702
4703 For example, if you are filtering Compute Engine instances, you can
4704 exclude instances named `example-instance` by specifying
4705 `name != example-instance`.
4706
4707 The `:*` comparison can be used to test whether a key has been defined.
4708 For example, to find all objects with `owner` label use:
4709 ```
4710 labels.owner:*
4711 ```
4712
4713 You can also filter nested fields. For example, you could specify
4714 `scheduling.automaticRestart = false` to include instances only
4715 if they are not scheduled for automatic restarts. You can use filtering
4716 on nested fields to filter based onresource labels.
4717
4718 To filter on multiple expressions, provide each separate expression within
4719 parentheses. For example:
4720 ```
4721 (scheduling.automaticRestart = true)
4722 (cpuPlatform = &quot;Intel Skylake&quot;)
4723 ```
4724 By default, each expression is an `AND` expression. However, you
4725 can include `AND` and `OR` expressions explicitly.
4726 For example:
4727 ```
4728 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4729 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4730 (scheduling.automaticRestart = true)
4731 ```
4732
4733 If you want to use a regular expression, use the `eq` (equal) or `ne`
4734 (not equal) operator against a single un-parenthesized expression with or
4735 without quotes or against multiple parenthesized expressions. Examples:
4736
4737 `fieldname eq unquoted literal`
4738 `fieldname eq &#x27;single quoted literal&#x27;`
4739 `fieldname eq &quot;double quoted literal&quot;`
4740 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4741
4742 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4743 The literal value must match the entire field.
4744
4745 For example, to filter for instances that do not end with name &quot;instance&quot;,
4746 you would use `name ne .*instance`.
4747
4748 You cannot combine constraints on multiple fields using regular
4749 expressions.
4750 maxResults: integer, The maximum number of results per page that should be returned.
4751 If the number of available results is larger than `maxResults`,
4752 Compute Engine returns a `nextPageToken` that can be used to get
4753 the next page of results in subsequent list requests. Acceptable values are
4754 `0` to `500`, inclusive. (Default: `500`)
4755 orderBy: string, Sorts list results by a certain order. By default, results
4756 are returned in alphanumerical order based on the resource name.
4757
4758 You can also sort results in descending order based on the creation
4759 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4760 results based on the `creationTimestamp` field in
4761 reverse chronological order (newest result first). Use this to sort
4762 resources like operations so that the newest operation is returned first.
4763
4764 Currently, only sorting by `name` or
4765 `creationTimestamp desc` is supported.
4766 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4767 `nextPageToken` returned by a previous list request to get
4768 the next page of results.
4769 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4770 of failure. The default value is false.
4771
4772 For example, when partial success behavior is enabled, aggregatedList for a
4773 single zone scope either returns all resources in the zone or no resources,
4774 with an error code.
4775 x__xgafv: string, V1 error format.
4776 Allowed values
4777 1 - v1 error format
4778 2 - v2 error format
4779
4780 Returns:
4781 An object of the form:
4782
4783 { # Contains a list of BackendService resources.
4784 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4785 &quot;items&quot;: [ # A list of BackendService resources.
4786 { # Represents a Backend Service resource.
4787 #
4788 # A backend service defines how Google Cloud load balancers distribute traffic.
4789 # The backend service configuration contains a set of values, such as the
4790 # protocol used to connect to backends, various distribution and session
4791 # settings, health checks, and timeouts. These settings provide fine-grained
4792 # control over how your load balancer behaves. Most of the settings have
4793 # default values that allow for easy configuration if you need to get started
4794 # quickly.
4795 #
4796 # Backend services in Google Compute Engine can be either regionally or
4797 # globally scoped.
4798 #
4799 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
4800 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
4801 #
4802 # For more information, seeBackend
4803 # Services.
4804 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
4805 # Load Balancers and Traffic Director and requires
4806 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
4807 #
4808 # If set to 0, the cookie is non-persistent and lasts only until
4809 # the end of the browser session (or equivalent). The maximum allowed value
4810 # is two weeks (1,209,600).
4811 #
4812 # Not supported when the backend service is referenced by a URL map that is
4813 # bound to target gRPC proxy that has validateForProxyless field set to true.
4814 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
4815 # load balancing scheme set to INTERNAL_SELF_MANAGED.
4816 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
4817 { # Message containing information of one individual backend.
4818 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
4819 # handle additional traffic or is fully loaded. For usage guidelines, see
4820 # Connection balancing mode.
4821 #
4822 # Backends must use compatible balancing modes. For more information, see
4823 # Supported balancing modes and target capacity settings and
4824 # Restrictions and guidance for instance groups.
4825 #
4826 # Note: Currently, if you use the API to configure incompatible balancing
4827 # modes, the configuration might be accepted even though it has no impact
4828 # and is ignored. Specifically, Backend.maxUtilization is ignored when
4829 # Backend.balancingMode is RATE. In the future, this incompatible combination
4830 # will be rejected.
4831 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
4832 # mode.
4833 # The default value is 1, which means the group serves up to
4834 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
4835 # completely drained, offering 0% of its available capacity. The valid ranges
4836 # are 0.0 and [0.1,1.0].
4837 # You cannot configure a setting larger than 0 and smaller than0.1.
4838 # You cannot configure a setting of 0 when there is only one
4839 # backend attached to the backend service.
4840 #
4841 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
4842 # internet NEGs, regional serverless NEGs, and PSC NEGs.
4843 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
4844 # BalancingMode.
4845 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
4846 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
4847 # Monitoring, but is not used for load balancing.
4848 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
4849 # balancing mode. The valid range is [0.0, 1.0].
4850 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
4851 # long and match the regular expression
4852 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
4853 # first character must be a lowercase letter, and all following
4854 # characters must be a dash, period, underscore, lowercase letter, or
4855 # digit, except the last character, which cannot be a dash, period, or
4856 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
4857 # field can only be used for a global or regional backend service with the
4858 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
4859 },
4860 ],
4861 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4862 # create the resource.
4863 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
4864 # failover backend can be configured for a given BackendService.
4865 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
4866 # group or network endpoint
4867 # group (NEG) resource. To determine what types of backends a load
4868 # balancer supports, see the [Backend services
4869 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
4870 #
4871 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
4872 # or NEG. Partial URLs are not supported.
4873 #
4874 # If haPolicy is specified, backends must refer to NEG resources of type
4875 # GCE_VM_IP.
4876 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
4877 # guidelines, seeConnection
4878 # balancing mode and Utilization
4879 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
4880 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
4881 # guidelines, seeConnection
4882 # balancing mode and Utilization
4883 # balancing mode.
4884 #
4885 # Not available if the backend&#x27;s balancingMode isRATE.
4886 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
4887 # For usage guidelines, seeConnection
4888 # balancing mode and Utilization
4889 # balancing mode.
4890 #
4891 # Not available if the backend&#x27;s balancingMode isRATE.
4892 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
4893 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
4894 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
4895 # Not available if backend&#x27;s balancingMode is RATE
4896 # or CONNECTION.
4897 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
4898 # Not available if backend&#x27;s balancingMode is RATE
4899 # or CONNECTION.
4900 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
4901 # usage guidelines, seeRate
4902 # balancing mode and Utilization
4903 # balancing mode.
4904 #
4905 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4906 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
4907 # guidelines, seeRate
4908 # balancing mode and Utilization
4909 # balancing mode.
4910 #
4911 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4912 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
4913 # guidelines, seeRate
4914 # balancing mode and Utilization
4915 # balancing mode.
4916 #
4917 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4918 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
4919 #
4920 # For usage guidelines, seeUtilization
4921 # balancing mode.
4922 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
4923 # the backend.
4924 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
4925 },
4926 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
4927 # sending traffic to backends with default preference. The possible values
4928 # are:
4929 #
4930 # - PREFERRED: Backends with this preference level will be
4931 # filled up to their capacity limits first, based on RTT.
4932 # - DEFAULT: If preferred backends don&#x27;t have enough
4933 # capacity, backends in this layer would be used and traffic would be
4934 # assigned based on the load balancing algorithm you use. This is the
4935 # default
4936 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
4937 # Attachment).
4938 # e.g.
4939 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
4940 # for Cloud Run service.
4941 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
4942 # for PSC Service Attachment.
4943 &quot;trafficDuration&quot;: &quot;A String&quot;,
4944 },
4945 ],
4946 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
4947 # specified load balancer types.
4948 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
4949 # Pragma or Authorization headers. Up to 5 headers can be specified.
4950 # The cache is bypassed for all cdnPolicy.cacheMode settings.
4951 { # Bypass the cache when the specified request headers are present,
4952 # e.g. Pragma or Authorization headers. Values are case insensitive.
4953 # The presence of such a header overrides the cache_mode setting.
4954 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
4955 # Values are case-insensitive.
4956 },
4957 ],
4958 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
4959 # CDN.
4960 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
4961 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
4962 &quot;A String&quot;,
4963 ],
4964 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
4965 # The name=value pair will be used in the cache key Cloud CDN generates.
4966 &quot;A String&quot;,
4967 ],
4968 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
4969 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
4970 # query_string_whitelist and query_string_blacklist. If neither is set, the
4971 # entire query string will be included. If false, the query string will be
4972 # excluded from the cache key entirely.
4973 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
4974 # parameters will be included. Either specify query_string_whitelist or
4975 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
4976 # not treated as delimiters.
4977 &quot;A String&quot;,
4978 ],
4979 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
4980 # parameters will be excluded. Either specify query_string_whitelist or
4981 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
4982 # not treated as delimiters.
4983 &quot;A String&quot;,
4984 ],
4985 },
4986 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
4987 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
4988 # headers to cache content. Responses without these headers will not be
4989 # cached at Google&#x27;s edge, and will require a full trip to the origin on
4990 # every request, potentially impacting performance and increasing load on
4991 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
4992 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
4993 # Warning: this may result in Cloud CDN caching private,
4994 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
4995 # including common image formats, media (video and audio), and web assets
4996 # (JavaScript and CSS). Requests and responses that are marked as
4997 # uncacheable, as well as dynamic content (including HTML), will not be
4998 # cached.
4999 #
5000 # If no value is provided for cdnPolicy.cacheMode, it defaults
5001 # to CACHE_ALL_STATIC.
5002 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
5003 # used to clamp the max-age (or Expires) value sent to the client. With
5004 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
5005 # response max-age directive, along with a &quot;public&quot; directive. For
5006 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
5007 # from the origin (if specified), or else sets the response max-age
5008 # directive to the lesser of the client_ttl and default_ttl, and also
5009 # ensures a &quot;public&quot; cache-control directive is present.
5010 # If a client TTL is not specified, a default value (1 hour) will be used.
5011 # The maximum allowed value is 31,622,400s (1 year).
5012 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
5013 # responses that do not have an existing valid TTL (max-age or s-maxage).
5014 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5015 # The value of defaultTTL cannot be set to a value greater than that of
5016 # maxTTL, but can be equal.
5017 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
5018 # will overwrite the TTL set in all responses. The maximum allowed value is
5019 # 31,622,400s (1 year), noting that infrequently accessed objects may be
5020 # evicted from the cache before the defined TTL.
5021 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
5022 # origin.
5023 # Cache directives that attempt to set a max-age or s-maxage higher than
5024 # this, or an Expires header more than maxTTL seconds in the future will
5025 # be capped at the value of maxTTL, as if it were the value of an
5026 # s-maxage Cache-Control directive.
5027 # Headers sent to the client will not be modified.
5028 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5029 # The maximum allowed value is 31,622,400s (1 year), noting that
5030 # infrequently accessed objects may be evicted from the cache before
5031 # the defined TTL.
5032 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
5033 # to apply fine-grained caching for common errors or redirects.
5034 # This can reduce the load on your origin and improve end-user
5035 # experience by reducing response latency.
5036 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
5037 # negative caching applies to responses with the specified response code
5038 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
5039 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
5040 # to all responses with the specified response code, and override any
5041 # caching headers.
5042 # By default, Cloud CDN will apply the following default TTLs to these
5043 # status codes:
5044 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
5045 # HTTP 404 (Not Found), 410 (Gone),
5046 # 451 (Unavailable For Legal Reasons): 120s
5047 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
5048 # These defaults can be overridden in negative_caching_policy.
5049 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
5050 # negative_caching must be enabled to configure negative_caching_policy.
5051 # Omitting the policy and leaving negative_caching enabled will use
5052 # Cloud CDN&#x27;s default cache TTLs.
5053 # Note that when specifying an explicit negative_caching_policy, you
5054 # should take care to specify a cache TTL for all response codes
5055 # that you wish to cache. Cloud CDN will not apply any default
5056 # negative caching when a policy exists.
5057 { # Specify CDN TTLs for response error codes.
5058 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
5059 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
5060 # specified as values, and you cannot specify a status code more than
5061 # once.
5062 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
5063 # corresponding status code.
5064 # The maximum allowed value is 1800s (30 minutes), noting that
5065 # infrequently accessed objects may be evicted from the cache before the
5066 # defined TTL.
5067 },
5068 ],
5069 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
5070 # requests into a small number of requests to the origin.
5071 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
5072 # content with the origin, or when an error is encountered when refreshing
5073 # the cache.
5074 # This setting defines the default &quot;max-stale&quot; duration for any cached
5075 # responses that do not specify a max-stale directive. Stale responses that
5076 # exceed the TTL configured here will not be served. The default limit
5077 # (max-stale) is 86400s (1 day), which will allow stale content to be
5078 # served up to this limit beyond the max-age (or s-maxage) of a cached
5079 # response.
5080 # The maximum allowed value is 604800 (1 week).
5081 # Set this to zero (0) to disable serve-while-stale.
5082 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
5083 # considered fresh. After this time period, the response will be
5084 # revalidated before being served. Defaults to 1hr (3600s). When serving
5085 # responses to signed URL requests, Cloud CDN will internally behave as
5086 # though all responses from this backend had a &quot;Cache-Control:
5087 # public, max-age=[TTL]&quot; header, regardless of any existing
5088 # Cache-Control header. The actual headers served in responses will not be
5089 # altered.
5090 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
5091 &quot;A String&quot;,
5092 ],
5093 },
5094 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
5095 # backend service.
5096 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
5097 # as a count of seconds and fractions of seconds at nanosecond
5098 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5099 # or &quot;month&quot;. Range is approximately 10,000 years.
5100 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5101 # Durations less than one second are represented with a 0
5102 # `seconds` field and a positive `nanos` field. Must be from 0
5103 # to 999,999,999 inclusive.
5104 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5105 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5106 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5107 },
5108 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
5109 # there is no limit.
5110 #
5111 # Not supported when the backend service is referenced by a URL map that is
5112 # bound to target gRPC proxy that has validateForProxyless field set to true.
5113 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
5114 # not specified, there is no limit.
5115 #
5116 # Not supported when the backend service is referenced by a URL map that is
5117 # bound to target gRPC proxy that has validateForProxyless field set to true.
5118 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
5119 # service. If not specified, there is no limit.
5120 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
5121 # This parameter is respected by both the HTTP/1.1 and HTTP/2
5122 # implementations. If not specified, there is no limit. Setting this
5123 # parameter to 1 will effectively disable keep alive.
5124 #
5125 # Not supported when the backend service is referenced by a URL map that is
5126 # bound to target gRPC proxy that has validateForProxyless field set to true.
5127 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
5128 # not specified, the default is 1.
5129 #
5130 # Not supported when the backend service is referenced by a URL map that is
5131 # bound to target gRPC proxy that has validateForProxyless field set to true.
5132 },
5133 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
5134 # the client&#x27;s Accept-Encoding header.
5135 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
5136 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
5137 # instance. For supported load balancers and protocols, as described inEnabling
5138 # connection draining.
5139 },
5140 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
5141 # tracking policy settings are only available for external passthrough
5142 # Network Load Balancers and internal passthrough Network Load Balancers.
5143 #
5144 # connectionTrackingPolicy cannot be specified with haPolicy.
5145 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
5146 # value is DEFAULT_FOR_PROTOCOL.
5147 #
5148 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
5149 # persist on unhealthy backends only for connection-oriented protocols
5150 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
5151 # Affinity is configured for 5-tuple. They do not persist forUDP.
5152 #
5153 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
5154 # the existing connections on the unhealthy backend are never persisted on
5155 # the unhealthy backend. They are always diverted to newly selected healthy
5156 # backends (unless all backends are unhealthy).
5157 #
5158 # If set to ALWAYS_PERSIST, existing connections always
5159 # persist on unhealthy backends regardless of protocol and session
5160 # affinity. It is generally not recommended to use this mode overriding the
5161 # default.
5162 #
5163 # For more details, see [Connection Persistence for Network Load
5164 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
5165 # and [Connection Persistence for Internal TCP/UDP Load
5166 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
5167 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
5168 # Balancers. This option is not available publicly.
5169 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
5170 # matching traffic (in seconds).
5171 #
5172 # For internal passthrough Network Load Balancers:
5173 #
5174 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
5175 # - It can be set only if Connection Tracking is less than 5-tuple
5176 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
5177 # Mode is PER_SESSION).
5178 #
5179 #
5180 #
5181 # For external passthrough Network Load Balancers the default is 60
5182 # seconds. This option is not available publicly.
5183 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
5184 # options:
5185 #
5186 # - PER_CONNECTION: This is the default mode. The Connection
5187 # Tracking is performed as per the Connection Key (default Hash Method) for
5188 # the specific protocol.
5189 # - PER_SESSION: The Connection Tracking is performed as per
5190 # the configured Session Affinity. It matches the configured Session
5191 # Affinity.
5192 #
5193 #
5194 #
5195 # For more details, see [Tracking Mode for Network Load
5196 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
5197 # and [Tracking Mode for Internal TCP/UDP Load
5198 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
5199 },
5200 &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
5201 # affinity based on HTTP headers, cookies or other properties. This load
5202 # balancing policy is applicable only for HTTP connections. The affinity to a
5203 # particular destination host will be lost when one or more hosts are
5204 # added/removed from the destination service. This field specifies parameters
5205 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
5206 #
5207 # This field is applicable to either:
5208 #
5209 # - A regional backend service with the service protocol set to HTTP,
5210 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
5211 # INTERNAL_MANAGED.
5212 # - A global backend service with the
5213 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5214 &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
5215 # be used as the hash key for the consistent hash load balancer. If the
5216 # cookie is not present, it will be generated. This field is applicable if
5217 # the sessionAffinity is set to HTTP_COOKIE.
5218 #
5219 # Not supported when the backend service is referenced by a URL map that is
5220 # bound to target gRPC proxy that has validateForProxyless field set to true.
5221 # for load balancing policies that use a consistent hash.
5222 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
5223 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
5224 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
5225 # as a count of seconds and fractions of seconds at nanosecond
5226 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5227 # or &quot;month&quot;. Range is approximately 10,000 years.
5228 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5229 # Durations less than one second are represented with a 0
5230 # `seconds` field and a positive `nanos` field. Must be from 0
5231 # to 999,999,999 inclusive.
5232 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5233 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5234 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5235 },
5236 },
5237 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
5238 # applicable if the sessionAffinity is set toHEADER_FIELD.
5239 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
5240 # 1024. Larger ring sizes result in more granular load distributions. If the
5241 # number of hosts in the load balancing pool is larger than the ring size,
5242 # each host will be assigned a single virtual node.
5243 },
5244 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5245 # text format.
5246 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
5247 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
5248 # locality_lb_policy.
5249 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
5250 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5251 # long and match the regular expression
5252 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5253 # first character must be a lowercase letter, and all following
5254 # characters must be a dash, period, underscore, lowercase letter, or
5255 # digit, except the last character, which cannot be a dash, period, or
5256 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5257 # field can only be used for a global or regional backend service with the
5258 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5259 },
5260 ],
5261 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
5262 # custom
5263 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5264 &quot;A String&quot;,
5265 ],
5266 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
5267 # custom
5268 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5269 &quot;A String&quot;,
5270 ],
5271 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5272 # create the resource.
5273 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
5274 # backend service with dynamic forwarding feature which together with Service
5275 # Extension allows customized and complex routing logic.
5276 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
5277 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
5278 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
5279 },
5280 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
5281 # service. Some ranges are restricted: Restricted
5282 # ranges.
5283 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
5284 },
5285 },
5286 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
5287 # this backend service.
5288 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
5289 # global external Application Load Balancer.
5290 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
5291 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
5292 #
5293 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
5294 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
5295 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
5296 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
5297 # externalManagedMigrationTestingPercentage.
5298 #
5299 # Rolling back a migration requires the states to be set in reverse order. So
5300 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
5301 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
5302 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
5303 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
5304 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
5305 # external Application Load Balancer.
5306 #
5307 # The value of this field must be in the range [0, 100].
5308 #
5309 # Session affinity options will slightly affect this routing behavior, for
5310 # more details, see:Session
5311 # Affinity.
5312 #
5313 # This value can only be set if the loadBalancingScheme in the BackendService
5314 # is set to EXTERNAL (when using the classic Application Load Balancer) and
5315 # the migration state is TEST_BY_PERCENTAGE.
5316 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
5317 # as a backup (failover) backend.
5318 # For load balancers that have configurable failover:
5319 # [Internal passthrough Network Load
5320 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5321 # and [external passthrough Network Load
5322 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5323 #
5324 # failoverPolicy cannot be specified with haPolicy.
5325 # failover:
5326 # [Internal passthrough Network Load
5327 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5328 # and [external passthrough
5329 # Network Load
5330 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5331 # On failover or failback, this field indicates whether connection draining
5332 # will be honored. Google Cloud has a fixed connection draining timeout of
5333 # 10 minutes. A setting of true terminates existing TCP
5334 # connections to the active pool during failover and failback, immediately
5335 # draining traffic. A setting of false allows existing TCP
5336 # connections to persist, even on VMs no longer in the active pool, for up
5337 # to the duration of the connection draining timeout (10 minutes).
5338 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
5339 #
5340 # The default is false.
5341 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
5342 # load balancer are dropped when all primary and all backup backend VMs are
5343 # unhealthy.If set to false, connections are distributed
5344 # among all primary VMs when all primary and all backup backend VMs are
5345 # unhealthy.
5346 # For load balancers that have configurable
5347 # failover:
5348 # [Internal passthrough
5349 # Network Load
5350 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5351 # and [external passthrough
5352 # Network Load
5353 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5354 # The default is false.
5355 &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
5356 # failover when the number of healthy primary VMs equals zero.
5357 # For all other values, the load balancer performs a failover when the
5358 # total number of healthy primary VMs is less than this ratio.
5359 # For load balancers that have configurable
5360 # failover:
5361 # [Internal TCP/UDP Load
5362 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5363 # and [external TCP/UDP Load
5364 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5365 },
5366 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
5367 # This field is used in optimistic locking. This field will be ignored when
5368 # inserting a BackendService. An up-to-date fingerprint must be provided in
5369 # order to update the BackendService, otherwise the request will
5370 # fail with error 412 conditionNotMet.
5371 #
5372 # To see the latest fingerprint, make a get() request to
5373 # retrieve a BackendService.
5374 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
5375 # Protocol Forwarding.
5376 #
5377 # The backends of this regional backend service must only specify zonal
5378 # network endpoint groups (NEGs) of type GCE_VM_IP.
5379 #
5380 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
5381 # regional backend service must set the network field. All zonal NEGs must
5382 # belong to the same network. However, individual NEGs can
5383 # belong to different subnetworks of that network.
5384 #
5385 # When haPolicy is specified, the set of attached network endpoints across
5386 # all backends comprise an High Availability domain from which one endpoint
5387 # is selected as the active endpoint (the leader) that receives all
5388 # traffic.
5389 #
5390 # haPolicy can be added only at backend service creation time. Once set up,
5391 # it cannot be deleted.
5392 #
5393 # Note that haPolicy is not for load balancing, and therefore cannot be
5394 # specified with sessionAffinity, connectionTrackingPolicy, and
5395 # failoverPolicy.
5396 #
5397 # haPolicy requires customers to be responsible for tracking backend
5398 # endpoint health and electing a leader among the healthy endpoints.
5399 # Therefore, haPolicy cannot be specified with healthChecks.
5400 #
5401 # haPolicy can only be specified for External Passthrough Network Load
5402 # Balancers and Internal Passthrough Network Load Balancers.
5403 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
5404 # achieve it.
5405 #
5406 # Supported values are:
5407 #
5408 # - DISABLED: Fast IP Move is disabled. You can only use the
5409 # haPolicy.leader API to update the leader.
5410 # - &gt;GARP_RA: Provides a method to very quickly define a new network
5411 # endpoint as the leader. This method is faster than updating the leader
5412 # using the haPolicy.leader API. Fast IP move works as follows: The VM
5413 # hosting the network endpoint that should become the new leader sends
5414 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
5415 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
5416 # temporarily associates the forwarding rule IP address with that VM, and
5417 # both new and in-flight packets are quickly delivered to that VM.
5418 #
5419 #
5420 #
5421 # Note the important properties of the Fast IP Move functionality:
5422 #
5423 # - The GARP/RA-initiated re-routing stays active for approximately 20
5424 # minutes. After triggering fast failover, you must also
5425 # appropriately set the haPolicy.leader.
5426 # - The new leader instance should continue to send GARP/RA packets
5427 # periodically every 10 seconds until at least 10 minutes after updating
5428 # the haPolicy.leader (but stop immediately if it is no longer the leader).
5429 # - After triggering a fast failover, we recommend that you wait at least
5430 # 3 seconds before sending another GARP/RA packet from a different VM
5431 # instance to avoid race conditions.
5432 # - Don&#x27;t send GARP/RA packets from different VM
5433 # instances at the same time. If multiple instances continue to send
5434 # GARP/RA packets, traffic might be routed to different destinations in an
5435 # alternating order. This condition ceases when a single instance
5436 # issues a GARP/RA packet.
5437 # - The GARP/RA request always takes priority over the leader API.
5438 # Using the haPolicy.leader API to change the leader to a different
5439 # instance will have no effect until the GARP/RA request becomes
5440 # inactive.
5441 # - The GARP/RA packets should follow the GARP/RA
5442 # Packet Specifications..
5443 # - When multiple forwarding rules refer to a regional backend service,
5444 # you need only send a GARP or RA packet for a single forwarding rule
5445 # virtual IP. The virtual IPs for all forwarding rules targeting the same
5446 # backend service will also be moved to the sender of the GARP or RA
5447 # packet.
5448 #
5449 #
5450 #
5451 # The following are the Fast IP Move limitations (that is, when fastIPMove
5452 # is not DISABLED):
5453 #
5454 # - Multiple forwarding rules cannot use the same IP address if one of
5455 # them refers to a regional backend service with fastIPMove.
5456 # - The regional backend service must set the network field, and all
5457 # NEGs must belong to that network. However, individual
5458 # NEGs can belong to different subnetworks of that network.
5459 # - The maximum number of network endpoints across all backends of a
5460 # backend service with fastIPMove is 32.
5461 # - The maximum number of backend services with fastIPMove that can have
5462 # the same network endpoint attached to one of its backends is 64.
5463 # - The maximum number of backend services with fastIPMove in a VPC in a
5464 # region is 64.
5465 # - The network endpoints that are attached to a backend of a backend
5466 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
5467 # - Traffic directed to the leader by a static route next hop will not be
5468 # redirected to a new leader by fast failover. Such traffic will only be
5469 # redirected once an haPolicy.leader update has taken effect. Only traffic
5470 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
5471 # fast failover.
5472 #
5473 #
5474 # haPolicy.fastIPMove can be set only at backend service creation time.
5475 # Once set, it cannot be updated.
5476 #
5477 # By default, fastIpMove is set to DISABLED.
5478 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
5479 # this service as the active endpoint (the leader) that receives all
5480 # traffic.
5481 #
5482 # When the leader changes, there is no connection draining to persist
5483 # existing connections on the old leader.
5484 #
5485 # You are responsible for selecting a suitable endpoint as the
5486 # leader. For example, preferring a healthy endpoint over unhealthy ones.
5487 # Note that this service does not track backend endpoint health, and
5488 # selects the configured leader unconditionally.
5489 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
5490 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
5491 # that the leader is attached to.
5492 #
5493 # The leader&#x27;s backendGroup must already be specified as a backend of
5494 # this backend service. Removing a backend that is designated as the
5495 # leader&#x27;s backendGroup is not permitted.
5496 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
5497 # designated as the leader.
5498 #
5499 # This network endpoint cannot be detached from the NEG specified in
5500 # the haPolicy.leader.backendGroup until the leader is updated with
5501 # another network endpoint, or the leader is removed from the haPolicy.
5502 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
5503 # instance must already be attached to the NEG specified in the
5504 # haPolicy.leader.backendGroup.
5505 #
5506 # The name must be 1-63 characters long, and comply with RFC1035.
5507 # Authorization requires the following IAM permission on the
5508 # specified resource instance: compute.instances.use
5509 },
5510 },
5511 },
5512 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
5513 # httpsHealthChecks (legacy) resource for health checking this backend
5514 # service. Not all backend services support legacy health checks. See
5515 # Load balancer guide. Currently, at most one health check can be
5516 # specified for each backend service. Backend services with
5517 # instance group or zonal NEG backends must have a health check unless
5518 # haPolicy is specified. Backend services with internet or serverless NEG
5519 # backends must not have a health check.
5520 #
5521 # healthChecks[] cannot be specified with haPolicy.
5522 &quot;A String&quot;,
5523 ],
5524 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
5525 # Not available for internal passthrough Network Load Balancers and external
5526 # passthrough Network Load Balancers.
5527 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
5528 # incoming requests.
5529 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
5530 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
5531 # for IAP.
5532 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
5533 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
5534 # Optional - If not provided, the name will be autogenerated by the
5535 # backend.
5536 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
5537 },
5538 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
5539 # For security reasons, this value cannot be retrieved via the API.
5540 # Instead, the SHA-256 hash of the value is returned in the
5541 # oauth2ClientSecretSha256 field.
5542 #
5543 # @InputOnly
5544 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
5545 },
5546 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5547 # defined by the server.
5548 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
5549 # from the client to the backend for proxyless gRPC).
5550 # The possible values are:
5551 #
5552 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
5553 # backend service (Instance Group, Managed Instance Group, Network Endpoint
5554 # Group), regardless of traffic from the client to the proxy. Only IPv4
5555 # health checks are used to check the health of the backends. This is the
5556 # default setting.
5557 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
5558 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
5559 # address).
5560 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
5561 # backend service (Instance Group, Managed Instance Group, Network Endpoint
5562 # Group), regardless of traffic from the client to the proxy. Only IPv6
5563 # health checks are used to check the health of the backends.
5564 #
5565 #
5566 #
5567 # This field is applicable to either:
5568 #
5569 # - Advanced global external Application Load Balancer (load balancing
5570 # scheme EXTERNAL_MANAGED),
5571 # - Regional external Application Load
5572 # Balancer,
5573 # - Internal proxy Network Load Balancer (load balancing
5574 # scheme INTERNAL_MANAGED),
5575 # - Regional internal Application Load
5576 # Balancer (load balancing scheme INTERNAL_MANAGED),
5577 # - Traffic
5578 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
5579 # INTERNAL_SELF_MANAGED).
5580 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
5581 # for backend services.
5582 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
5583 # created for one type of load balancer cannot be used with another.
5584 # For more information, refer toChoosing
5585 # a load balancer.
5586 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
5587 # preference. When you use localityLbPolicies, you must set at least one
5588 # value for either the localityLbPolicies[].policy or the
5589 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
5590 # value set in the localityLbPolicy field.
5591 #
5592 # For an example of how to use this field, seeDefine
5593 # a list of preferred policies.
5594 #
5595 # Caution: This field and its children are intended for use in a service mesh
5596 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
5597 # that have this configuration.
5598 { # Container for either a built-in LB policy supported by gRPC or Envoy or
5599 # a custom one implemented by the end user.
5600 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
5601 # deployed with the client.
5602 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
5603 # by a locally installed custom policy implementation.
5604 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
5605 #
5606 # The value should match the name of a custom implementation registered
5607 # on the gRPC clients. It should follow protocol buffer message naming
5608 # conventions and include the full path (for example,
5609 # myorg.CustomLbPolicy). The maximum length is 256 characters.
5610 #
5611 # Do not specify the same custom policy more than once for a
5612 # backend. If you do, the configuration is rejected.
5613 #
5614 # For an example of how to use this field, seeUse
5615 # a custom policy.
5616 },
5617 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
5618 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
5619 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
5620 # about these values, see the description of localityLbPolicy.
5621 #
5622 # Do not specify the same policy more than once for a
5623 # backend. If you do, the configuration is rejected.
5624 },
5625 },
5626 ],
5627 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
5628 # possible values are:
5629 #
5630 # - ROUND_ROBIN: This is a simple policy in which each healthy
5631 # backend is selected in round robin order. This is the default.
5632 # - LEAST_REQUEST: An O(1) algorithm which
5633 # selects two random healthy hosts and picks the host which has fewer active
5634 # requests.
5635 # - RING_HASH: The ring/modulo hash load balancer implements
5636 # consistent hashing to backends. The algorithm has the property that the
5637 # addition/removal of a host from a set of N hosts only affects 1/N of the
5638 # requests.
5639 # - RANDOM: The load balancer selects a random healthy
5640 # host.
5641 # - ORIGINAL_DESTINATION: Backend host is selected
5642 # based on the client connection metadata, i.e., connections are opened to
5643 # the same address as the destination address of the incoming connection
5644 # before the connection was redirected to the load balancer.
5645 # - MAGLEV: used as a drop in replacement for the ring hash
5646 # load balancer. Maglev is not as stable as ring hash but has faster table
5647 # lookup build times and host selection times. For more information about
5648 # Maglev, see Maglev:
5649 # A Fast and Reliable Software Network Load Balancer.
5650 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
5651 # Load Balancing using weights computed from Backend reported Custom Metrics.
5652 # If set, the Backend Service responses are expected to contain non-standard
5653 # HTTP response header field Endpoint-Load-Metrics. The reported
5654 # metrics to use for computing the weights are specified via thecustomMetrics field.
5655 #
5656 # This field is applicable to either:
5657 # - A regional backend service with the service protocol set to HTTP,
5658 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
5659 # INTERNAL_MANAGED.
5660 # - A global backend service with the
5661 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
5662 # EXTERNAL_MANAGED.
5663 #
5664 #
5665 # If sessionAffinity is not configured—that is, if session
5666 # affinity remains at the default value of NONE—then the
5667 # default value for localityLbPolicy
5668 # is ROUND_ROBIN. If session affinity is set to a value other
5669 # than NONE,
5670 # then the default value for localityLbPolicy isMAGLEV.
5671 #
5672 # Only ROUND_ROBIN and RING_HASH are supported
5673 # when the backend service is referenced by a URL map that is bound to
5674 # target gRPC proxy that has validateForProxyless field set to true.
5675 #
5676 # localityLbPolicy cannot be specified with haPolicy.
5677 &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
5678 # by this backend service. If logging is enabled, logs will be exported to
5679 # Stackdriver.
5680 # backend service.
5681 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
5682 # traffic served by this backend service. The default value is false.
5683 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
5684 { # Determines which HTTP headers will be logged to Stackdriver.
5685 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
5686 },
5687 ],
5688 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
5689 { # Determines which HTTP headers will be logged to Stackdriver.
5690 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
5691 },
5692 ],
5693 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
5694 # This field can only be specified if logging is enabled for this backend
5695 # service. Configures whether all, none or a subset of optional fields
5696 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
5697 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
5698 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
5699 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
5700 # of optional fields you want to include in the logs. For example:
5701 # serverInstance, serverGkeDetails.cluster,
5702 # serverGkeDetails.pod.podNamespace
5703 &quot;A String&quot;,
5704 ],
5705 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
5706 # service. Configures whether all, none or a subset of optional fields
5707 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
5708 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
5709 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
5710 # service. The value of the field must be in [0, 1]. This configures the
5711 # sampling rate of requests to the load balancer where 1.0 means all logged
5712 # requests are reported and 0.0 means no logged requests are reported. The
5713 # default value is 1.0.
5714 },
5715 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
5716 # service. Duration is computed from the beginning of the stream until the
5717 # response has been completely processed, including all retries. A stream
5718 # that does not complete in this duration is closed.
5719 #
5720 # If not specified, there will be no timeout limit, i.e. the maximum
5721 # duration is infinite.
5722 #
5723 # This value can be overridden in the PathMatcher configuration of the
5724 # UrlMap that references this backend service.
5725 #
5726 # This field is only allowed when the loadBalancingScheme of
5727 # the backend service is INTERNAL_SELF_MANAGED.
5728 # as a count of seconds and fractions of seconds at nanosecond
5729 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5730 # or &quot;month&quot;. Range is approximately 10,000 years.
5731 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5732 # Durations less than one second are represented with a 0
5733 # `seconds` field and a positive `nanos` field. Must be from 0
5734 # to 999,999,999 inclusive.
5735 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5736 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5737 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5738 },
5739 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
5740 # controller and read by the backend RCTH
5741 &quot;a_key&quot;: &quot;A String&quot;,
5742 },
5743 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
5744 # The name must be 1-63 characters long, and comply withRFC1035.
5745 # Specifically, the name must be 1-63 characters long and match the regular
5746 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5747 # character must be a lowercase letter, and all following characters must
5748 # be a dash, lowercase letter, or digit, except the last character, which
5749 # cannot be a dash.
5750 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
5751 #
5752 # This field must be set for Internal Passthrough Network Load Balancers when
5753 # the haPolicy is enabled, and for External Passthrough Network Load
5754 # Balancers when the haPolicy fastIpMove is enabled.
5755 #
5756 # 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.
5757 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
5758 # Load Balancers.
5759 #
5760 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
5761 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
5762 # endpoints in the local zone.
5763 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
5764 # possible values are:
5765 #
5766 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
5767 # is disabled. The load balancer distributes new connections to all
5768 # healthy backend endpoints across all zones.
5769 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
5770 # enabled. The load balancer distributes new connections to all healthy
5771 # backend endpoints in the local zone only. If there are no healthy
5772 # backend endpoints in the local zone, the load balancer distributes
5773 # new connections to all backend endpoints in the local zone.
5774 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
5775 # enabled. The load balancer distributes new connections to all healthy
5776 # backend endpoints in the local zone only. If there aren&#x27;t enough
5777 # healthy backend endpoints in the local zone, the load balancer
5778 # distributes new connections to all healthy backend endpoints across all
5779 # zones.
5780 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
5781 # of healthy backend endpoints in a zone to the count of backend
5782 # endpoints in that same zone is equal to or above this threshold, the
5783 # load balancer distributes new connections to all healthy endpoints in
5784 # the local zone only. When the ratio of the count of healthy backend
5785 # endpoints in a zone to the count of backend endpoints in that same
5786 # zone is below this threshold, the load balancer distributes all new
5787 # connections to all healthy endpoints across all zones.
5788 },
5789 },
5790 &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.
5791 # the backend service.
5792 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
5793 # service.
5794 },
5795 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
5796 # load balancing pool of each individual proxy instance that processes the
5797 # traffic for the given backend service. If not set, this feature is
5798 # considered disabled.
5799 #
5800 # Results of the outlier detection algorithm (ejection of endpoints from the
5801 # load balancing pool and returning them back to the pool) are executed
5802 # independently by each proxy instance of the load balancer. In most cases,
5803 # more than one proxy instance handles the traffic received by a backend
5804 # service. Thus, it is possible that an unhealthy endpoint is detected and
5805 # ejected by only some of the proxies, and while this happens, other proxies
5806 # may continue to send requests to the same unhealthy endpoint until they
5807 # detect and eject the unhealthy endpoint.
5808 #
5809 # Applicable backend endpoints can be:
5810 #
5811 # - VM instances in an Instance Group
5812 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
5813 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
5814 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
5815 # Functions Services
5816 # - Private Service Connect NEGs, that resolve to
5817 # Google-managed regional API endpoints or managed services published using
5818 # Private Service Connect
5819 #
5820 #
5821 #
5822 # Applicable backend service types can be:
5823 #
5824 # - A global backend service with the loadBalancingScheme set to
5825 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
5826 # - A regional backend
5827 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
5828 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
5829 # supported for Serverless NEGs.
5830 #
5831 #
5832 #
5833 # Not supported when the backend service is referenced by a URL map that is
5834 # bound to target gRPC proxy that has validateForProxyless field set to true.
5835 # pool for the backend service.
5836 &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
5837 # or 30s.
5838 #
5839 # After a backend endpoint is returned back to the load balancing pool, it
5840 # can be ejected again in another ejection analysis. Thus, the total ejection
5841 # time is equal to the base ejection time multiplied by the number of times
5842 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
5843 # as a count of seconds and fractions of seconds at nanosecond
5844 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5845 # or &quot;month&quot;. Range is approximately 10,000 years.
5846 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5847 # Durations less than one second are represented with a 0
5848 # `seconds` field and a positive `nanos` field. Must be from 0
5849 # to 999,999,999 inclusive.
5850 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5851 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5852 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5853 },
5854 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
5855 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
5856 # return code qualifies as an error. Defaults to 5.
5857 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
5858 # connection errors that are mapped to one of those status codes) before a
5859 # consecutive gateway failure ejection occurs. Defaults to 3.
5860 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5861 # outlier status is detected through consecutive 5xx. This setting can be
5862 # used to disable ejection or to ramp it up slowly. Defaults to 0.
5863 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5864 # outlier status is detected through consecutive gateway failures. This
5865 # setting can be used to disable ejection or to ramp it up slowly. Defaults
5866 # to 100.
5867 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5868 # outlier status is detected through success rate statistics. This setting
5869 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
5870 #
5871 # Not supported when the backend service uses Serverless NEG.
5872 &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
5873 # ejections and backend endpoints being returned to service. The interval is
5874 # equal to the number of seconds as defined in
5875 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
5876 # in outlierDetection.interval.nanos. Defaults to 1 second.
5877 # as a count of seconds and fractions of seconds at nanosecond
5878 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5879 # or &quot;month&quot;. Range is approximately 10,000 years.
5880 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5881 # Durations less than one second are represented with a 0
5882 # `seconds` field and a positive `nanos` field. Must be from 0
5883 # to 999,999,999 inclusive.
5884 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5885 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5886 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5887 },
5888 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
5889 # backend service that can be ejected if the ejection conditions are met.
5890 # Defaults to 50%.
5891 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
5892 # enough request volume to detect success rate outliers. If the number of
5893 # backend endpoints is fewer than this setting, outlier detection via success
5894 # rate statistics is not performed for any backend endpoint in the load
5895 # balancing pool. Defaults to 5.
5896 #
5897 # Not supported when the backend service uses Serverless NEG.
5898 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
5899 # (as defined by the interval duration above) to include this backend
5900 # endpoint in success rate based outlier detection. If the volume is lower
5901 # than this setting, outlier detection via success rate statistics is not
5902 # performed for that backend endpoint. Defaults to 100.
5903 #
5904 # Not supported when the backend service uses Serverless NEG.
5905 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
5906 # outlier ejection. The ejection threshold is the difference between the mean
5907 # success rate, and the product of this factor and the standard deviation of
5908 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
5909 # is divided by a thousand to get a double. That is, if the desired factor
5910 # is 1.9, the runtime value should be 1900. Defaults to 1900.
5911 #
5912 # Not supported when the backend service uses Serverless NEG.
5913 },
5914 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
5915 # as part of resource payload.
5916 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
5917 # Tag keys and values have the same definition as resource
5918 # manager tags. The field is allowed for INSERT
5919 # only. The keys/values to set on the resource should be specified in
5920 # either ID { : } or Namespaced format
5921 # { : }.
5922 # For example the following are valid inputs:
5923 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
5924 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
5925 # Note:
5926 # * Invalid combinations of ID &amp; namespaced format is not supported. For
5927 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
5928 &quot;a_key&quot;: &quot;A String&quot;,
5929 },
5930 },
5931 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
5932 # the backend. The default value is 80.
5933 # For internal passthrough Network Load Balancers and external passthrough
5934 # Network Load Balancers, omit port.
5935 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
5936 # communication to the backend VMs in that group. The
5937 # named port must be [defined on each backend instance
5938 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
5939 # This parameter has no meaning if the backends are NEGs. For internal
5940 # passthrough Network Load Balancers and external passthrough Network Load
5941 # Balancers, omit port_name.
5942 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
5943 # with backends.
5944 #
5945 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
5946 # depending on the chosen load balancer or Traffic Director configuration.
5947 # Refer to the documentation for the load balancers or for Traffic Director
5948 # for more information.
5949 #
5950 # Must be set to GRPC when the backend service is referenced by a URL map
5951 # that is bound to target gRPC proxy.
5952 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
5953 # resides. This field is not applicable to global backend services.
5954 # You must specify this field as part of the HTTP request URL. It is
5955 # not settable as a field in the request body.
5956 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
5957 # backend service.
5958 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
5959 # service. This field is applicable to a global backend service with the
5960 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5961 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
5962 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
5963 # be accepted on backends, and if authenticated, which method/certificate
5964 # will set the request principal.
5965 # request principal.
5966 # The authentication settings for the backend service.
5967 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
5968 # Similar to peers, these will be evaluated in order the first valid one
5969 # will be used to set origin identity. If none of these methods pass, the
5970 # request will be rejected with authentication failed error (401). Leave the
5971 # list empty if origin authentication is not required.
5972 { # [Deprecated] Configuration for the origin authentication method.
5973 # Configuration for the origin authentication method.
5974 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
5975 # JWT configuration for origin authentication.
5976 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
5977 # will be accepted if audiences is empty.
5978 # Examples: bookstore_android.apps.googleusercontent.com,
5979 # bookstore_web.apps.googleusercontent.com
5980 &quot;A String&quot;,
5981 ],
5982 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
5983 # email address.
5984 # Examples: https://securetoken.google.com,
5985 # [email protected]
5986 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
5987 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
5988 # request. If no explicit location is specified, the following default
5989 # locations are tried in order:
5990 #
5991 # 1. The Authorization header using the Bearer schema. See `here
5992 # `_. Example:
5993 #
5994 # Authorization: Bearer .
5995 #
5996 # 2. `access_token` query parameter. See `this
5997 # `_
5998 #
5999 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
6000 # from the locations its issuer specified or from the default locations.
6001 #
6002 # This field is set if JWT is sent in a request header. This field specifies
6003 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
6004 # header format will be x-goog-iap-jwt-assertion: .
6005 { # [Deprecated] This message specifies a header location to extract JWT token.
6006 # This message specifies a header location to extract JWT token.
6007 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
6008 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
6009 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
6010 # with a space at the end.
6011 },
6012 ],
6013 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
6014 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
6015 # JWT format in the query parameter is /path?jwt_token=.
6016 &quot;A String&quot;,
6017 ],
6018 },
6019 },
6020 ],
6021 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
6022 # They will be evaluated in order the first valid one will be used to set
6023 # peer identity. If none of these methods pass, the request will be rejected
6024 # with authentication failed error (401). Leave the list empty if peer
6025 # authentication is not required.
6026 { # [Deprecated] Configuration for the peer authentication method.
6027 # Configuration for the peer authentication method.
6028 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
6029 # Configuration for the mutual Tls mode for peer authentication.
6030 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
6031 # field can be set to one of the following:
6032 # STRICT: Client certificate must be presented, connection is in TLS.
6033 # PERMISSIVE: Client certificate can be omitted, connection can be either
6034 # plaintext or TLS.
6035 },
6036 },
6037 ],
6038 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
6039 # Default value is USE_PEER. If peer (or origin) identity is not available,
6040 # either because peer/origin authentication is not defined, or failed,
6041 # principal will be left unset. In other words, binding rule does not affect
6042 # the decision to accept or reject request. This field can be set to one of
6043 # the following:
6044 # USE_PEER: Principal will be set to the identity from peer authentication.
6045 # USE_ORIGIN: Principal will be set to the identity from origin
6046 # authentication.
6047 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
6048 # identity information.
6049 # The TLS settings for the client or server.
6050 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
6051 # certificate.
6052 # Defines the mechanism to obtain the client or server certificate.
6053 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
6054 # applicable only if tlsCertificateSource is set to USE_PATH.
6055 # The paths to the mounted TLS Certificates and private key.
6056 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
6057 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
6058 },
6059 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
6060 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
6061 # is applicable only if tlsCertificateSource is set to USE_SDS.
6062 # The configuration to access the SDS server.
6063 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
6064 # gRPC config to access the SDS server.
6065 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
6066 # gRPC call credentials to access the SDS server.
6067 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
6068 # This field can be set to one of the following:
6069 #
6070 # - GCE_VM: The local GCE VM service account credentials are used to access
6071 # the SDS server.
6072 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
6073 # SDS server.
6074 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
6075 # FROM_PLUGIN.
6076 # Custom authenticator credentials.
6077 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
6078 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
6079 # plugin.
6080 },
6081 },
6082 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
6083 # gRPC channel credentials to access the SDS server.
6084 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
6085 # The paths to the mounted TLS Certificates and private key.
6086 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
6087 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
6088 },
6089 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
6090 # to one of the following:
6091 # CERTIFICATES: Use TLS certificates to access the SDS server.
6092 # GCE_VM: Use local GCE VM credentials to access the SDS server.
6093 },
6094 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
6095 },
6096 },
6097 },
6098 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
6099 # validate the client/server certificate. If omitted, the proxy will not
6100 # validate the server or client certificate.
6101 # certificate to validate the client/server certificate.
6102 # validate the client/server certificate.
6103 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
6104 # client or server certificate.
6105 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
6106 # is applicable only if tlsCertificateSource is set to USE_SDS.
6107 # The configuration to access the SDS server.
6108 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
6109 # gRPC config to access the SDS server.
6110 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
6111 # gRPC call credentials to access the SDS server.
6112 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
6113 # This field can be set to one of the following:
6114 #
6115 # - GCE_VM: The local GCE VM service account credentials are used to access
6116 # the SDS server.
6117 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
6118 # SDS server.
6119 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
6120 # FROM_PLUGIN.
6121 # Custom authenticator credentials.
6122 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
6123 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
6124 # plugin.
6125 },
6126 },
6127 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
6128 # gRPC channel credentials to access the SDS server.
6129 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
6130 # The paths to the mounted TLS Certificates and private key.
6131 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
6132 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
6133 },
6134 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
6135 # to one of the following:
6136 # CERTIFICATES: Use TLS certificates to access the SDS server.
6137 # GCE_VM: Use local GCE VM credentials to access the SDS server.
6138 },
6139 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
6140 },
6141 },
6142 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
6143 },
6144 },
6145 },
6146 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
6147 # (RBAC) config.
6148 # Authorization config defines the Role Based Access Control (RBAC) config.
6149 # method-level access control for a service.
6150 # control for a service.
6151 &quot;policies&quot;: [ # List of RbacPolicies.
6152 {
6153 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
6154 &quot;permissions&quot;: [ # The list of permissions.
6155 { # [Deprecated] All fields defined in a permission are ANDed.
6156 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
6157 { # Custom constraint that specifies a key and a list of allowed values for
6158 # Istio attributes.
6159 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
6160 &quot;values&quot;: [ # A list of allowed values.
6161 &quot;A String&quot;,
6162 ],
6163 },
6164 ],
6165 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
6166 # applies to. Exact match, prefix match, and suffix match are supported.
6167 &quot;A String&quot;,
6168 ],
6169 &quot;methods&quot;: [ # HTTP method.
6170 &quot;A String&quot;,
6171 ],
6172 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
6173 &quot;A String&quot;,
6174 ],
6175 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
6176 &quot;A String&quot;,
6177 ],
6178 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
6179 &quot;A String&quot;,
6180 ],
6181 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
6182 &quot;A String&quot;,
6183 ],
6184 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
6185 # Exact match, prefix match, and suffix match are supported.
6186 &quot;A String&quot;,
6187 ],
6188 &quot;ports&quot;: [ # Port names or numbers.
6189 &quot;A String&quot;,
6190 ],
6191 },
6192 ],
6193 &quot;principals&quot;: [ # The list of principals.
6194 { # [Deprecated] All fields defined in a principal are ANDed.
6195 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
6196 &quot;groups&quot;: [ # The groups the principal belongs to.
6197 # Exact match, prefix match, and suffix match are supported.
6198 &quot;A String&quot;,
6199 ],
6200 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
6201 &quot;A String&quot;,
6202 ],
6203 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
6204 &quot;A String&quot;,
6205 ],
6206 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
6207 &quot;A String&quot;,
6208 ],
6209 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
6210 &quot;A String&quot;,
6211 ],
6212 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
6213 &quot;A String&quot;,
6214 ],
6215 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
6216 &quot;A String&quot;,
6217 ],
6218 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
6219 # suffix match are supported for values. For example,
6220 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
6221 &quot;a_key&quot;: &quot;A String&quot;,
6222 },
6223 &quot;users&quot;: [ # The user names/IDs or service accounts.
6224 # Exact match, prefix match, and suffix match are supported.
6225 &quot;A String&quot;,
6226 ],
6227 },
6228 ],
6229 },
6230 ],
6231 },
6232 &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
6233 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
6234 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
6235 # private storage buckets that support Signature Version 4 for authentication.
6236 # The service name for generating the authentication header will always default
6237 # to &#x27;s3&#x27;.
6238 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
6239 # creating a backend that uses AWS v4 signature authentication, but will not
6240 # be returned as part of the configuration when queried with a REST API GET
6241 # request.
6242 #
6243 # @InputOnly
6244 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
6245 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
6246 # keep track of different iterations of your access key.
6247 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
6248 # the name of the region your cloud uses to host your origin. For example,
6249 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
6250 },
6251 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
6252 # that describes how clients should authenticate with this service&#x27;s
6253 # backends.
6254 #
6255 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
6256 # to INTERNAL_SELF_MANAGED.
6257 #
6258 # If left blank, communications are not encrypted.
6259 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
6260 # originating from the backend service.
6261 # the backend service.
6262 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
6263 # identity information. This field is only applicable when mode is set to
6264 # MUTUAL.
6265 # The TLS settings for the client or server.
6266 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
6267 # certificate.
6268 # Defines the mechanism to obtain the client or server certificate.
6269 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
6270 # applicable only if tlsCertificateSource is set to USE_PATH.
6271 # The paths to the mounted TLS Certificates and private key.
6272 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
6273 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
6274 },
6275 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
6276 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
6277 # is applicable only if tlsCertificateSource is set to USE_SDS.
6278 # The configuration to access the SDS server.
6279 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
6280 # gRPC config to access the SDS server.
6281 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
6282 # gRPC call credentials to access the SDS server.
6283 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
6284 # This field can be set to one of the following:
6285 #
6286 # - GCE_VM: The local GCE VM service account credentials are used to access
6287 # the SDS server.
6288 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
6289 # SDS server.
6290 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
6291 # FROM_PLUGIN.
6292 # Custom authenticator credentials.
6293 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
6294 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
6295 # plugin.
6296 },
6297 },
6298 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
6299 # gRPC channel credentials to access the SDS server.
6300 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
6301 # The paths to the mounted TLS Certificates and private key.
6302 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
6303 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
6304 },
6305 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
6306 # to one of the following:
6307 # CERTIFICATES: Use TLS certificates to access the SDS server.
6308 # GCE_VM: Use local GCE VM credentials to access the SDS server.
6309 },
6310 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
6311 },
6312 },
6313 },
6314 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
6315 # validate the client/server certificate. If omitted, the proxy will not
6316 # validate the server or client certificate.
6317 # certificate to validate the client/server certificate.
6318 # validate the client/server certificate.
6319 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
6320 # client or server certificate.
6321 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
6322 # is applicable only if tlsCertificateSource is set to USE_SDS.
6323 # The configuration to access the SDS server.
6324 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
6325 # gRPC config to access the SDS server.
6326 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
6327 # gRPC call credentials to access the SDS server.
6328 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
6329 # This field can be set to one of the following:
6330 #
6331 # - GCE_VM: The local GCE VM service account credentials are used to access
6332 # the SDS server.
6333 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
6334 # SDS server.
6335 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
6336 # FROM_PLUGIN.
6337 # Custom authenticator credentials.
6338 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
6339 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
6340 # plugin.
6341 },
6342 },
6343 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
6344 # gRPC channel credentials to access the SDS server.
6345 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
6346 # The paths to the mounted TLS Certificates and private key.
6347 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
6348 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
6349 },
6350 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
6351 # to one of the following:
6352 # CERTIFICATES: Use TLS certificates to access the SDS server.
6353 # GCE_VM: Use local GCE VM credentials to access the SDS server.
6354 },
6355 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
6356 },
6357 },
6358 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
6359 },
6360 },
6361 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
6362 # The value of this field determines how TLS is enforced. This can be set
6363 # to one of the following values: DISABLE: Do not setup a TLS connection to
6364 # the backends.
6365 # SIMPLE: Originate a TLS connection to the backends.
6366 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
6367 # client certificates for authentication.
6368 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
6369 # applicable only when mode is SIMPLE or MUTUAL.
6370 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
6371 # certificate.If specified,
6372 # the proxy will verify that the server certificate&#x27;s subject alt name
6373 # matches one of the specified values. This field is applicable only when
6374 # mode is SIMPLE or MUTUAL.
6375 &quot;A String&quot;,
6376 ],
6377 },
6378 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
6379 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
6380 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
6381 # specified values, the communication continues. Otherwise, it fails. This
6382 # additional check enables the client to verify that the server is authorized
6383 # to run the requested service.
6384 #
6385 # Note that the contents of the server
6386 # certificate&#x27;s subjectAltName field are configured by the
6387 # Public Key Infrastructure which provisions server identities.
6388 #
6389 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
6390 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
6391 # mode).
6392 &quot;A String&quot;,
6393 ],
6394 },
6395 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6396 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
6397 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
6398 #
6399 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
6400 # If set, lists of backends and health checks must be both empty.
6401 &quot;A String&quot;,
6402 ],
6403 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
6404 #
6405 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
6406 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
6407 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
6408 #
6409 # Only NONE and HEADER_FIELD are supported
6410 # when the backend service is referenced by a URL map that is bound to
6411 # target gRPC proxy that has validateForProxyless field set to true.
6412 #
6413 # For more details, see:
6414 # [Session
6415 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
6416 #
6417 # sessionAffinity cannot be specified with haPolicy.
6418 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
6419 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
6420 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6421 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6422 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6423 # as a count of seconds and fractions of seconds at nanosecond
6424 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6425 # or &quot;month&quot;. Range is approximately 10,000 years.
6426 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6427 # Durations less than one second are represented with a 0
6428 # `seconds` field and a positive `nanos` field. Must be from 0
6429 # to 999,999,999 inclusive.
6430 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6431 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6432 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6433 },
6434 },
6435 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
6436 # Currently this is applicable only for Internal TCP/UDP load balancing,
6437 # Internal HTTP(S) load balancing and Traffic Director.
6438 &quot;policy&quot;: &quot;A String&quot;,
6439 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
6440 # each service mesh client.
6441 #
6442 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
6443 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
6444 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
6445 # `INTERNAL_SELF_MANAGED`.
6446 #
6447 # `subset_size` is optional for Internal HTTP(S) load balancing
6448 # and required for Traffic Director.
6449 #
6450 # If you do not provide this value, Cloud Load Balancing will calculate it
6451 # dynamically to optimize the number of proxies/clients visible to each
6452 # backend and vice versa.
6453 #
6454 # Must be greater than 0. If `subset_size` is larger than the number of
6455 # backends/endpoints, then subsetting is disabled.
6456 },
6457 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
6458 # type of load balancer. For more information see,
6459 # Backend service settings.
6460 # The default is 30 seconds.
6461 # The full range of timeout values allowed goes from 1
6462 # through 2,147,483,647 seconds.
6463 #
6464 # This value can be overridden in the PathMatcher configuration of the
6465 # UrlMap that references this backend service.
6466 #
6467 # Not supported when the backend service is referenced by a URL map that is
6468 # bound to target gRPC proxy that has validateForProxyless field set to true.
6469 # Instead, use maxStreamDuration.
6470 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
6471 # when the backend protocol is SSL, HTTPS or HTTP2.
6472 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
6473 # networksecurity.googleapis.com namespace. Can be used in authenticating
6474 # TLS connections to the backend, as specified by the authenticationMode
6475 # field. Can only be specified if authenticationMode is not NONE.
6476 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
6477 #
6478 #
6479 # Use this property to configure the load balancer back-end to use
6480 # certificates and roots of trust provisioned by the Managed Workload
6481 # Identity system.
6482 #
6483 # The `identity` property is the
6484 # fully-specified SPIFFE ID to use in the SVID presented by the Load
6485 # Balancer Workload.
6486 #
6487 # The SPIFFE ID must be a resource starting with the
6488 # `trustDomain` property value, followed by the path to the Managed
6489 # Workload Identity.
6490 #
6491 # Supported SPIFFE ID format:
6492 #
6493 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
6494 #
6495 #
6496 # The Trust Domain within the Managed Identity must refer to a valid
6497 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
6498 # will be inherited from the Workload Identity Pool.
6499 #
6500 # Restrictions:
6501 #
6502 # - If you set the `identity` property, you cannot manually set
6503 # the following fields:
6504 # - tlsSettings.sni
6505 # - tlsSettings.subjectAltNames
6506 # - tlsSettings.authenticationConfig
6507 #
6508 #
6509 # When defining a `identity` for a RegionBackendServices, the
6510 # corresponding Workload Identity Pool must have a ca_pool
6511 # configured in the same region.
6512 #
6513 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
6514 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
6515 # balancer sends this string as the SNI hostname in the TLS connection to
6516 # the backend, and requires that this string match a Subject Alternative
6517 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
6518 # NEG backend, if the SNI is specified here, the load balancer uses it
6519 # regardless of whether the Regional Internet NEG is specified with FQDN or
6520 # IP address and port. When both sni and subjectAltNames[] are specified,
6521 # the load balancer matches the backend certificate&#x27;s SAN only to
6522 # subjectAltNames[].
6523 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
6524 # verifies during a TLS handshake with the backend. When the server
6525 # presents its X.509 certificate to the Load Balancer, the Load Balancer
6526 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
6527 # match one of the subjectAltNames in the list. This field is limited to 5
6528 # entries. When both sni and subjectAltNames[] are specified, the load
6529 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
6530 { # A Subject Alternative Name that the load balancer matches against the SAN
6531 # field in the TLS certificate provided by the backend, specified as either
6532 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
6533 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
6534 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
6535 },
6536 ],
6537 },
6538 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
6539 {
6540 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
6541 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
6542 # and ForwardingRule.
6543 },
6544 ],
6545 },
6546 ],
6547 &quot;kind&quot;: &quot;compute#backendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.
6548 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
6549 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
6550 # the query parameter pageToken in the next list request.
6551 # Subsequent list requests will have their own nextPageToken to
6552 # continue paging through the results.
6553 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
6554 &quot;warning&quot;: { # [Output Only] Informational warning message.
6555 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6556 # Engine returns NO_RESULTS_ON_PAGE if there
6557 # are no results in the response.
6558 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6559 # value format. For example:
6560 #
6561 # &quot;data&quot;: [
6562 # {
6563 # &quot;key&quot;: &quot;scope&quot;,
6564 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6565 # }
6566 {
6567 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6568 # returned. For example, for warnings where there are no results in a list
6569 # request for a particular zone, this key might be scope and
6570 # the key value might be the zone name. Other examples might be a key
6571 # indicating a deprecated resource and a suggested replacement, or a
6572 # warning about invalid network settings (for example, if an instance
6573 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6574 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6575 },
6576 ],
6577 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6578 },
6579 }</pre>
6580 </div>
6581
6582 <div class="method">
6583 <code class="details" id="listUsable">listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
6584 <pre>Retrieves a list of all usable backend services in the specified project in
6585 the given region.
6586
6587 Args:
6588 project: string, Project ID for this request. (required)
6589 region: string, Name of the region scoping this request.
6590 It must be a string that meets the requirements in RFC1035. (required)
6591 filter: string, A filter expression that filters resources listed in the response. Most
6592 Compute resources support two types of filter expressions:
6593 expressions that support regular expressions and expressions that follow
6594 API improvement proposal AIP-160.
6595 These two types of filter expressions cannot be mixed in one request.
6596
6597 If you want to use AIP-160, your expression must specify the field name, an
6598 operator, and the value that you want to use for filtering. The value
6599 must be a string, a number, or a boolean. The operator
6600 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
6601
6602 For example, if you are filtering Compute Engine instances, you can
6603 exclude instances named `example-instance` by specifying
6604 `name != example-instance`.
6605
6606 The `:*` comparison can be used to test whether a key has been defined.
6607 For example, to find all objects with `owner` label use:
6608 ```
6609 labels.owner:*
6610 ```
6611
6612 You can also filter nested fields. For example, you could specify
6613 `scheduling.automaticRestart = false` to include instances only
6614 if they are not scheduled for automatic restarts. You can use filtering
6615 on nested fields to filter based onresource labels.
6616
6617 To filter on multiple expressions, provide each separate expression within
6618 parentheses. For example:
6619 ```
6620 (scheduling.automaticRestart = true)
6621 (cpuPlatform = &quot;Intel Skylake&quot;)
6622 ```
6623 By default, each expression is an `AND` expression. However, you
6624 can include `AND` and `OR` expressions explicitly.
6625 For example:
6626 ```
6627 (cpuPlatform = &quot;Intel Skylake&quot;) OR
6628 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
6629 (scheduling.automaticRestart = true)
6630 ```
6631
6632 If you want to use a regular expression, use the `eq` (equal) or `ne`
6633 (not equal) operator against a single un-parenthesized expression with or
6634 without quotes or against multiple parenthesized expressions. Examples:
6635
6636 `fieldname eq unquoted literal`
6637 `fieldname eq &#x27;single quoted literal&#x27;`
6638 `fieldname eq &quot;double quoted literal&quot;`
6639 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
6640
6641 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
6642 The literal value must match the entire field.
6643
6644 For example, to filter for instances that do not end with name &quot;instance&quot;,
6645 you would use `name ne .*instance`.
6646
6647 You cannot combine constraints on multiple fields using regular
6648 expressions.
6649 maxResults: integer, The maximum number of results per page that should be returned.
6650 If the number of available results is larger than `maxResults`,
6651 Compute Engine returns a `nextPageToken` that can be used to get
6652 the next page of results in subsequent list requests. Acceptable values are
6653 `0` to `500`, inclusive. (Default: `500`)
6654 orderBy: string, Sorts list results by a certain order. By default, results
6655 are returned in alphanumerical order based on the resource name.
6656
6657 You can also sort results in descending order based on the creation
6658 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
6659 results based on the `creationTimestamp` field in
6660 reverse chronological order (newest result first). Use this to sort
6661 resources like operations so that the newest operation is returned first.
6662
6663 Currently, only sorting by `name` or
6664 `creationTimestamp desc` is supported.
6665 pageToken: string, Specifies a page token to use. Set `pageToken` to the
6666 `nextPageToken` returned by a previous list request to get
6667 the next page of results.
6668 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
6669 of failure. The default value is false.
6670
6671 For example, when partial success behavior is enabled, aggregatedList for a
6672 single zone scope either returns all resources in the zone or no resources,
6673 with an error code.
6674 x__xgafv: string, V1 error format.
6675 Allowed values
6676 1 - v1 error format
6677 2 - v2 error format
6678
6679 Returns:
6680 An object of the form:
6681
6682 { # Contains a list of usable BackendService resources.
6683 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
6684 &quot;items&quot;: [ # A list of BackendService resources.
6685 { # Represents a Backend Service resource.
6686 #
6687 # A backend service defines how Google Cloud load balancers distribute traffic.
6688 # The backend service configuration contains a set of values, such as the
6689 # protocol used to connect to backends, various distribution and session
6690 # settings, health checks, and timeouts. These settings provide fine-grained
6691 # control over how your load balancer behaves. Most of the settings have
6692 # default values that allow for easy configuration if you need to get started
6693 # quickly.
6694 #
6695 # Backend services in Google Compute Engine can be either regionally or
6696 # globally scoped.
6697 #
6698 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
6699 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
6700 #
6701 # For more information, seeBackend
6702 # Services.
6703 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
6704 # Load Balancers and Traffic Director and requires
6705 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
6706 #
6707 # If set to 0, the cookie is non-persistent and lasts only until
6708 # the end of the browser session (or equivalent). The maximum allowed value
6709 # is two weeks (1,209,600).
6710 #
6711 # Not supported when the backend service is referenced by a URL map that is
6712 # bound to target gRPC proxy that has validateForProxyless field set to true.
6713 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
6714 # load balancing scheme set to INTERNAL_SELF_MANAGED.
6715 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
6716 { # Message containing information of one individual backend.
6717 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
6718 # handle additional traffic or is fully loaded. For usage guidelines, see
6719 # Connection balancing mode.
6720 #
6721 # Backends must use compatible balancing modes. For more information, see
6722 # Supported balancing modes and target capacity settings and
6723 # Restrictions and guidance for instance groups.
6724 #
6725 # Note: Currently, if you use the API to configure incompatible balancing
6726 # modes, the configuration might be accepted even though it has no impact
6727 # and is ignored. Specifically, Backend.maxUtilization is ignored when
6728 # Backend.balancingMode is RATE. In the future, this incompatible combination
6729 # will be rejected.
6730 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
6731 # mode.
6732 # The default value is 1, which means the group serves up to
6733 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
6734 # completely drained, offering 0% of its available capacity. The valid ranges
6735 # are 0.0 and [0.1,1.0].
6736 # You cannot configure a setting larger than 0 and smaller than0.1.
6737 # You cannot configure a setting of 0 when there is only one
6738 # backend attached to the backend service.
6739 #
6740 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
6741 # internet NEGs, regional serverless NEGs, and PSC NEGs.
6742 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
6743 # BalancingMode.
6744 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
6745 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
6746 # Monitoring, but is not used for load balancing.
6747 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
6748 # balancing mode. The valid range is [0.0, 1.0].
6749 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6750 # long and match the regular expression
6751 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6752 # first character must be a lowercase letter, and all following
6753 # characters must be a dash, period, underscore, lowercase letter, or
6754 # digit, except the last character, which cannot be a dash, period, or
6755 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6756 # field can only be used for a global or regional backend service with the
6757 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6758 },
6759 ],
6760 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6761 # create the resource.
6762 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
6763 # failover backend can be configured for a given BackendService.
6764 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
6765 # group or network endpoint
6766 # group (NEG) resource. To determine what types of backends a load
6767 # balancer supports, see the [Backend services
6768 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
6769 #
6770 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
6771 # or NEG. Partial URLs are not supported.
6772 #
6773 # If haPolicy is specified, backends must refer to NEG resources of type
6774 # GCE_VM_IP.
6775 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6776 # guidelines, seeConnection
6777 # balancing mode and Utilization
6778 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
6779 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6780 # guidelines, seeConnection
6781 # balancing mode and Utilization
6782 # balancing mode.
6783 #
6784 # Not available if the backend&#x27;s balancingMode isRATE.
6785 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
6786 # For usage guidelines, seeConnection
6787 # balancing mode and Utilization
6788 # balancing mode.
6789 #
6790 # Not available if the backend&#x27;s balancingMode isRATE.
6791 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
6792 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
6793 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
6794 # Not available if backend&#x27;s balancingMode is RATE
6795 # or CONNECTION.
6796 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
6797 # Not available if backend&#x27;s balancingMode is RATE
6798 # or CONNECTION.
6799 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
6800 # usage guidelines, seeRate
6801 # balancing mode and Utilization
6802 # balancing mode.
6803 #
6804 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6805 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6806 # guidelines, seeRate
6807 # balancing mode and Utilization
6808 # balancing mode.
6809 #
6810 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6811 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6812 # guidelines, seeRate
6813 # balancing mode and Utilization
6814 # balancing mode.
6815 #
6816 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6817 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
6818 #
6819 # For usage guidelines, seeUtilization
6820 # balancing mode.
6821 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
6822 # the backend.
6823 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
6824 },
6825 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
6826 # sending traffic to backends with default preference. The possible values
6827 # are:
6828 #
6829 # - PREFERRED: Backends with this preference level will be
6830 # filled up to their capacity limits first, based on RTT.
6831 # - DEFAULT: If preferred backends don&#x27;t have enough
6832 # capacity, backends in this layer would be used and traffic would be
6833 # assigned based on the load balancing algorithm you use. This is the
6834 # default
6835 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
6836 # Attachment).
6837 # e.g.
6838 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
6839 # for Cloud Run service.
6840 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
6841 # for PSC Service Attachment.
6842 &quot;trafficDuration&quot;: &quot;A String&quot;,
6843 },
6844 ],
6845 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
6846 # specified load balancer types.
6847 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
6848 # Pragma or Authorization headers. Up to 5 headers can be specified.
6849 # The cache is bypassed for all cdnPolicy.cacheMode settings.
6850 { # Bypass the cache when the specified request headers are present,
6851 # e.g. Pragma or Authorization headers. Values are case insensitive.
6852 # The presence of such a header overrides the cache_mode setting.
6853 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
6854 # Values are case-insensitive.
6855 },
6856 ],
6857 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
6858 # CDN.
6859 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
6860 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
6861 &quot;A String&quot;,
6862 ],
6863 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
6864 # The name=value pair will be used in the cache key Cloud CDN generates.
6865 &quot;A String&quot;,
6866 ],
6867 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
6868 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
6869 # query_string_whitelist and query_string_blacklist. If neither is set, the
6870 # entire query string will be included. If false, the query string will be
6871 # excluded from the cache key entirely.
6872 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
6873 # parameters will be included. Either specify query_string_whitelist or
6874 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6875 # not treated as delimiters.
6876 &quot;A String&quot;,
6877 ],
6878 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
6879 # parameters will be excluded. Either specify query_string_whitelist or
6880 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6881 # not treated as delimiters.
6882 &quot;A String&quot;,
6883 ],
6884 },
6885 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
6886 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
6887 # headers to cache content. Responses without these headers will not be
6888 # cached at Google&#x27;s edge, and will require a full trip to the origin on
6889 # every request, potentially impacting performance and increasing load on
6890 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
6891 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
6892 # Warning: this may result in Cloud CDN caching private,
6893 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
6894 # including common image formats, media (video and audio), and web assets
6895 # (JavaScript and CSS). Requests and responses that are marked as
6896 # uncacheable, as well as dynamic content (including HTML), will not be
6897 # cached.
6898 #
6899 # If no value is provided for cdnPolicy.cacheMode, it defaults
6900 # to CACHE_ALL_STATIC.
6901 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
6902 # used to clamp the max-age (or Expires) value sent to the client. With
6903 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
6904 # response max-age directive, along with a &quot;public&quot; directive. For
6905 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
6906 # from the origin (if specified), or else sets the response max-age
6907 # directive to the lesser of the client_ttl and default_ttl, and also
6908 # ensures a &quot;public&quot; cache-control directive is present.
6909 # If a client TTL is not specified, a default value (1 hour) will be used.
6910 # The maximum allowed value is 31,622,400s (1 year).
6911 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
6912 # responses that do not have an existing valid TTL (max-age or s-maxage).
6913 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6914 # The value of defaultTTL cannot be set to a value greater than that of
6915 # maxTTL, but can be equal.
6916 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
6917 # will overwrite the TTL set in all responses. The maximum allowed value is
6918 # 31,622,400s (1 year), noting that infrequently accessed objects may be
6919 # evicted from the cache before the defined TTL.
6920 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
6921 # origin.
6922 # Cache directives that attempt to set a max-age or s-maxage higher than
6923 # this, or an Expires header more than maxTTL seconds in the future will
6924 # be capped at the value of maxTTL, as if it were the value of an
6925 # s-maxage Cache-Control directive.
6926 # Headers sent to the client will not be modified.
6927 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6928 # The maximum allowed value is 31,622,400s (1 year), noting that
6929 # infrequently accessed objects may be evicted from the cache before
6930 # the defined TTL.
6931 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
6932 # to apply fine-grained caching for common errors or redirects.
6933 # This can reduce the load on your origin and improve end-user
6934 # experience by reducing response latency.
6935 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
6936 # negative caching applies to responses with the specified response code
6937 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
6938 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
6939 # to all responses with the specified response code, and override any
6940 # caching headers.
6941 # By default, Cloud CDN will apply the following default TTLs to these
6942 # status codes:
6943 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
6944 # HTTP 404 (Not Found), 410 (Gone),
6945 # 451 (Unavailable For Legal Reasons): 120s
6946 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
6947 # These defaults can be overridden in negative_caching_policy.
6948 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
6949 # negative_caching must be enabled to configure negative_caching_policy.
6950 # Omitting the policy and leaving negative_caching enabled will use
6951 # Cloud CDN&#x27;s default cache TTLs.
6952 # Note that when specifying an explicit negative_caching_policy, you
6953 # should take care to specify a cache TTL for all response codes
6954 # that you wish to cache. Cloud CDN will not apply any default
6955 # negative caching when a policy exists.
6956 { # Specify CDN TTLs for response error codes.
6957 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
6958 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
6959 # specified as values, and you cannot specify a status code more than
6960 # once.
6961 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
6962 # corresponding status code.
6963 # The maximum allowed value is 1800s (30 minutes), noting that
6964 # infrequently accessed objects may be evicted from the cache before the
6965 # defined TTL.
6966 },
6967 ],
6968 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
6969 # requests into a small number of requests to the origin.
6970 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
6971 # content with the origin, or when an error is encountered when refreshing
6972 # the cache.
6973 # This setting defines the default &quot;max-stale&quot; duration for any cached
6974 # responses that do not specify a max-stale directive. Stale responses that
6975 # exceed the TTL configured here will not be served. The default limit
6976 # (max-stale) is 86400s (1 day), which will allow stale content to be
6977 # served up to this limit beyond the max-age (or s-maxage) of a cached
6978 # response.
6979 # The maximum allowed value is 604800 (1 week).
6980 # Set this to zero (0) to disable serve-while-stale.
6981 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
6982 # considered fresh. After this time period, the response will be
6983 # revalidated before being served. Defaults to 1hr (3600s). When serving
6984 # responses to signed URL requests, Cloud CDN will internally behave as
6985 # though all responses from this backend had a &quot;Cache-Control:
6986 # public, max-age=[TTL]&quot; header, regardless of any existing
6987 # Cache-Control header. The actual headers served in responses will not be
6988 # altered.
6989 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
6990 &quot;A String&quot;,
6991 ],
6992 },
6993 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
6994 # backend service.
6995 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
6996 # as a count of seconds and fractions of seconds at nanosecond
6997 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6998 # or &quot;month&quot;. Range is approximately 10,000 years.
6999 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7000 # Durations less than one second are represented with a 0
7001 # `seconds` field and a positive `nanos` field. Must be from 0
7002 # to 999,999,999 inclusive.
7003 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7004 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7005 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7006 },
7007 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
7008 # there is no limit.
7009 #
7010 # Not supported when the backend service is referenced by a URL map that is
7011 # bound to target gRPC proxy that has validateForProxyless field set to true.
7012 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
7013 # not specified, there is no limit.
7014 #
7015 # Not supported when the backend service is referenced by a URL map that is
7016 # bound to target gRPC proxy that has validateForProxyless field set to true.
7017 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
7018 # service. If not specified, there is no limit.
7019 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
7020 # This parameter is respected by both the HTTP/1.1 and HTTP/2
7021 # implementations. If not specified, there is no limit. Setting this
7022 # parameter to 1 will effectively disable keep alive.
7023 #
7024 # Not supported when the backend service is referenced by a URL map that is
7025 # bound to target gRPC proxy that has validateForProxyless field set to true.
7026 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
7027 # not specified, the default is 1.
7028 #
7029 # Not supported when the backend service is referenced by a URL map that is
7030 # bound to target gRPC proxy that has validateForProxyless field set to true.
7031 },
7032 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
7033 # the client&#x27;s Accept-Encoding header.
7034 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
7035 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
7036 # instance. For supported load balancers and protocols, as described inEnabling
7037 # connection draining.
7038 },
7039 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
7040 # tracking policy settings are only available for external passthrough
7041 # Network Load Balancers and internal passthrough Network Load Balancers.
7042 #
7043 # connectionTrackingPolicy cannot be specified with haPolicy.
7044 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
7045 # value is DEFAULT_FOR_PROTOCOL.
7046 #
7047 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
7048 # persist on unhealthy backends only for connection-oriented protocols
7049 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
7050 # Affinity is configured for 5-tuple. They do not persist forUDP.
7051 #
7052 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
7053 # the existing connections on the unhealthy backend are never persisted on
7054 # the unhealthy backend. They are always diverted to newly selected healthy
7055 # backends (unless all backends are unhealthy).
7056 #
7057 # If set to ALWAYS_PERSIST, existing connections always
7058 # persist on unhealthy backends regardless of protocol and session
7059 # affinity. It is generally not recommended to use this mode overriding the
7060 # default.
7061 #
7062 # For more details, see [Connection Persistence for Network Load
7063 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
7064 # and [Connection Persistence for Internal TCP/UDP Load
7065 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
7066 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
7067 # Balancers. This option is not available publicly.
7068 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
7069 # matching traffic (in seconds).
7070 #
7071 # For internal passthrough Network Load Balancers:
7072 #
7073 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
7074 # - It can be set only if Connection Tracking is less than 5-tuple
7075 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
7076 # Mode is PER_SESSION).
7077 #
7078 #
7079 #
7080 # For external passthrough Network Load Balancers the default is 60
7081 # seconds. This option is not available publicly.
7082 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
7083 # options:
7084 #
7085 # - PER_CONNECTION: This is the default mode. The Connection
7086 # Tracking is performed as per the Connection Key (default Hash Method) for
7087 # the specific protocol.
7088 # - PER_SESSION: The Connection Tracking is performed as per
7089 # the configured Session Affinity. It matches the configured Session
7090 # Affinity.
7091 #
7092 #
7093 #
7094 # For more details, see [Tracking Mode for Network Load
7095 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
7096 # and [Tracking Mode for Internal TCP/UDP Load
7097 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
7098 },
7099 &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
7100 # affinity based on HTTP headers, cookies or other properties. This load
7101 # balancing policy is applicable only for HTTP connections. The affinity to a
7102 # particular destination host will be lost when one or more hosts are
7103 # added/removed from the destination service. This field specifies parameters
7104 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
7105 #
7106 # This field is applicable to either:
7107 #
7108 # - A regional backend service with the service protocol set to HTTP,
7109 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7110 # INTERNAL_MANAGED.
7111 # - A global backend service with the
7112 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7113 &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
7114 # be used as the hash key for the consistent hash load balancer. If the
7115 # cookie is not present, it will be generated. This field is applicable if
7116 # the sessionAffinity is set to HTTP_COOKIE.
7117 #
7118 # Not supported when the backend service is referenced by a URL map that is
7119 # bound to target gRPC proxy that has validateForProxyless field set to true.
7120 # for load balancing policies that use a consistent hash.
7121 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7122 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7123 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7124 # as a count of seconds and fractions of seconds at nanosecond
7125 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7126 # or &quot;month&quot;. Range is approximately 10,000 years.
7127 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7128 # Durations less than one second are represented with a 0
7129 # `seconds` field and a positive `nanos` field. Must be from 0
7130 # to 999,999,999 inclusive.
7131 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7132 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7133 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7134 },
7135 },
7136 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
7137 # applicable if the sessionAffinity is set toHEADER_FIELD.
7138 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
7139 # 1024. Larger ring sizes result in more granular load distributions. If the
7140 # number of hosts in the load balancing pool is larger than the ring size,
7141 # each host will be assigned a single virtual node.
7142 },
7143 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7144 # text format.
7145 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
7146 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
7147 # locality_lb_policy.
7148 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
7149 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
7150 # long and match the regular expression
7151 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
7152 # first character must be a lowercase letter, and all following
7153 # characters must be a dash, period, underscore, lowercase letter, or
7154 # digit, except the last character, which cannot be a dash, period, or
7155 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
7156 # field can only be used for a global or regional backend service with the
7157 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
7158 },
7159 ],
7160 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
7161 # custom
7162 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7163 &quot;A String&quot;,
7164 ],
7165 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
7166 # custom
7167 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7168 &quot;A String&quot;,
7169 ],
7170 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7171 # create the resource.
7172 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
7173 # backend service with dynamic forwarding feature which together with Service
7174 # Extension allows customized and complex routing logic.
7175 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
7176 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
7177 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
7178 },
7179 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
7180 # service. Some ranges are restricted: Restricted
7181 # ranges.
7182 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
7183 },
7184 },
7185 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
7186 # this backend service.
7187 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
7188 # global external Application Load Balancer.
7189 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
7190 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
7191 #
7192 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
7193 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
7194 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
7195 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
7196 # externalManagedMigrationTestingPercentage.
7197 #
7198 # Rolling back a migration requires the states to be set in reverse order. So
7199 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
7200 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
7201 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
7202 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
7203 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
7204 # external Application Load Balancer.
7205 #
7206 # The value of this field must be in the range [0, 100].
7207 #
7208 # Session affinity options will slightly affect this routing behavior, for
7209 # more details, see:Session
7210 # Affinity.
7211 #
7212 # This value can only be set if the loadBalancingScheme in the BackendService
7213 # is set to EXTERNAL (when using the classic Application Load Balancer) and
7214 # the migration state is TEST_BY_PERCENTAGE.
7215 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
7216 # as a backup (failover) backend.
7217 # For load balancers that have configurable failover:
7218 # [Internal passthrough Network Load
7219 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7220 # and [external passthrough Network Load
7221 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7222 #
7223 # failoverPolicy cannot be specified with haPolicy.
7224 # failover:
7225 # [Internal passthrough Network Load
7226 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7227 # and [external passthrough
7228 # Network Load
7229 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7230 # On failover or failback, this field indicates whether connection draining
7231 # will be honored. Google Cloud has a fixed connection draining timeout of
7232 # 10 minutes. A setting of true terminates existing TCP
7233 # connections to the active pool during failover and failback, immediately
7234 # draining traffic. A setting of false allows existing TCP
7235 # connections to persist, even on VMs no longer in the active pool, for up
7236 # to the duration of the connection draining timeout (10 minutes).
7237 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
7238 #
7239 # The default is false.
7240 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
7241 # load balancer are dropped when all primary and all backup backend VMs are
7242 # unhealthy.If set to false, connections are distributed
7243 # among all primary VMs when all primary and all backup backend VMs are
7244 # unhealthy.
7245 # For load balancers that have configurable
7246 # failover:
7247 # [Internal passthrough
7248 # Network Load
7249 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7250 # and [external passthrough
7251 # Network Load
7252 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7253 # The default is false.
7254 &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
7255 # failover when the number of healthy primary VMs equals zero.
7256 # For all other values, the load balancer performs a failover when the
7257 # total number of healthy primary VMs is less than this ratio.
7258 # For load balancers that have configurable
7259 # failover:
7260 # [Internal TCP/UDP Load
7261 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7262 # and [external TCP/UDP Load
7263 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7264 },
7265 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
7266 # This field is used in optimistic locking. This field will be ignored when
7267 # inserting a BackendService. An up-to-date fingerprint must be provided in
7268 # order to update the BackendService, otherwise the request will
7269 # fail with error 412 conditionNotMet.
7270 #
7271 # To see the latest fingerprint, make a get() request to
7272 # retrieve a BackendService.
7273 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
7274 # Protocol Forwarding.
7275 #
7276 # The backends of this regional backend service must only specify zonal
7277 # network endpoint groups (NEGs) of type GCE_VM_IP.
7278 #
7279 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
7280 # regional backend service must set the network field. All zonal NEGs must
7281 # belong to the same network. However, individual NEGs can
7282 # belong to different subnetworks of that network.
7283 #
7284 # When haPolicy is specified, the set of attached network endpoints across
7285 # all backends comprise an High Availability domain from which one endpoint
7286 # is selected as the active endpoint (the leader) that receives all
7287 # traffic.
7288 #
7289 # haPolicy can be added only at backend service creation time. Once set up,
7290 # it cannot be deleted.
7291 #
7292 # Note that haPolicy is not for load balancing, and therefore cannot be
7293 # specified with sessionAffinity, connectionTrackingPolicy, and
7294 # failoverPolicy.
7295 #
7296 # haPolicy requires customers to be responsible for tracking backend
7297 # endpoint health and electing a leader among the healthy endpoints.
7298 # Therefore, haPolicy cannot be specified with healthChecks.
7299 #
7300 # haPolicy can only be specified for External Passthrough Network Load
7301 # Balancers and Internal Passthrough Network Load Balancers.
7302 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
7303 # achieve it.
7304 #
7305 # Supported values are:
7306 #
7307 # - DISABLED: Fast IP Move is disabled. You can only use the
7308 # haPolicy.leader API to update the leader.
7309 # - &gt;GARP_RA: Provides a method to very quickly define a new network
7310 # endpoint as the leader. This method is faster than updating the leader
7311 # using the haPolicy.leader API. Fast IP move works as follows: The VM
7312 # hosting the network endpoint that should become the new leader sends
7313 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
7314 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
7315 # temporarily associates the forwarding rule IP address with that VM, and
7316 # both new and in-flight packets are quickly delivered to that VM.
7317 #
7318 #
7319 #
7320 # Note the important properties of the Fast IP Move functionality:
7321 #
7322 # - The GARP/RA-initiated re-routing stays active for approximately 20
7323 # minutes. After triggering fast failover, you must also
7324 # appropriately set the haPolicy.leader.
7325 # - The new leader instance should continue to send GARP/RA packets
7326 # periodically every 10 seconds until at least 10 minutes after updating
7327 # the haPolicy.leader (but stop immediately if it is no longer the leader).
7328 # - After triggering a fast failover, we recommend that you wait at least
7329 # 3 seconds before sending another GARP/RA packet from a different VM
7330 # instance to avoid race conditions.
7331 # - Don&#x27;t send GARP/RA packets from different VM
7332 # instances at the same time. If multiple instances continue to send
7333 # GARP/RA packets, traffic might be routed to different destinations in an
7334 # alternating order. This condition ceases when a single instance
7335 # issues a GARP/RA packet.
7336 # - The GARP/RA request always takes priority over the leader API.
7337 # Using the haPolicy.leader API to change the leader to a different
7338 # instance will have no effect until the GARP/RA request becomes
7339 # inactive.
7340 # - The GARP/RA packets should follow the GARP/RA
7341 # Packet Specifications..
7342 # - When multiple forwarding rules refer to a regional backend service,
7343 # you need only send a GARP or RA packet for a single forwarding rule
7344 # virtual IP. The virtual IPs for all forwarding rules targeting the same
7345 # backend service will also be moved to the sender of the GARP or RA
7346 # packet.
7347 #
7348 #
7349 #
7350 # The following are the Fast IP Move limitations (that is, when fastIPMove
7351 # is not DISABLED):
7352 #
7353 # - Multiple forwarding rules cannot use the same IP address if one of
7354 # them refers to a regional backend service with fastIPMove.
7355 # - The regional backend service must set the network field, and all
7356 # NEGs must belong to that network. However, individual
7357 # NEGs can belong to different subnetworks of that network.
7358 # - The maximum number of network endpoints across all backends of a
7359 # backend service with fastIPMove is 32.
7360 # - The maximum number of backend services with fastIPMove that can have
7361 # the same network endpoint attached to one of its backends is 64.
7362 # - The maximum number of backend services with fastIPMove in a VPC in a
7363 # region is 64.
7364 # - The network endpoints that are attached to a backend of a backend
7365 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
7366 # - Traffic directed to the leader by a static route next hop will not be
7367 # redirected to a new leader by fast failover. Such traffic will only be
7368 # redirected once an haPolicy.leader update has taken effect. Only traffic
7369 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
7370 # fast failover.
7371 #
7372 #
7373 # haPolicy.fastIPMove can be set only at backend service creation time.
7374 # Once set, it cannot be updated.
7375 #
7376 # By default, fastIpMove is set to DISABLED.
7377 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
7378 # this service as the active endpoint (the leader) that receives all
7379 # traffic.
7380 #
7381 # When the leader changes, there is no connection draining to persist
7382 # existing connections on the old leader.
7383 #
7384 # You are responsible for selecting a suitable endpoint as the
7385 # leader. For example, preferring a healthy endpoint over unhealthy ones.
7386 # Note that this service does not track backend endpoint health, and
7387 # selects the configured leader unconditionally.
7388 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
7389 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
7390 # that the leader is attached to.
7391 #
7392 # The leader&#x27;s backendGroup must already be specified as a backend of
7393 # this backend service. Removing a backend that is designated as the
7394 # leader&#x27;s backendGroup is not permitted.
7395 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
7396 # designated as the leader.
7397 #
7398 # This network endpoint cannot be detached from the NEG specified in
7399 # the haPolicy.leader.backendGroup until the leader is updated with
7400 # another network endpoint, or the leader is removed from the haPolicy.
7401 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
7402 # instance must already be attached to the NEG specified in the
7403 # haPolicy.leader.backendGroup.
7404 #
7405 # The name must be 1-63 characters long, and comply with RFC1035.
7406 # Authorization requires the following IAM permission on the
7407 # specified resource instance: compute.instances.use
7408 },
7409 },
7410 },
7411 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
7412 # httpsHealthChecks (legacy) resource for health checking this backend
7413 # service. Not all backend services support legacy health checks. See
7414 # Load balancer guide. Currently, at most one health check can be
7415 # specified for each backend service. Backend services with
7416 # instance group or zonal NEG backends must have a health check unless
7417 # haPolicy is specified. Backend services with internet or serverless NEG
7418 # backends must not have a health check.
7419 #
7420 # healthChecks[] cannot be specified with haPolicy.
7421 &quot;A String&quot;,
7422 ],
7423 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
7424 # Not available for internal passthrough Network Load Balancers and external
7425 # passthrough Network Load Balancers.
7426 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
7427 # incoming requests.
7428 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
7429 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
7430 # for IAP.
7431 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
7432 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
7433 # Optional - If not provided, the name will be autogenerated by the
7434 # backend.
7435 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
7436 },
7437 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
7438 # For security reasons, this value cannot be retrieved via the API.
7439 # Instead, the SHA-256 hash of the value is returned in the
7440 # oauth2ClientSecretSha256 field.
7441 #
7442 # @InputOnly
7443 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
7444 },
7445 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7446 # defined by the server.
7447 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
7448 # from the client to the backend for proxyless gRPC).
7449 # The possible values are:
7450 #
7451 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
7452 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7453 # Group), regardless of traffic from the client to the proxy. Only IPv4
7454 # health checks are used to check the health of the backends. This is the
7455 # default setting.
7456 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
7457 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
7458 # address).
7459 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
7460 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7461 # Group), regardless of traffic from the client to the proxy. Only IPv6
7462 # health checks are used to check the health of the backends.
7463 #
7464 #
7465 #
7466 # This field is applicable to either:
7467 #
7468 # - Advanced global external Application Load Balancer (load balancing
7469 # scheme EXTERNAL_MANAGED),
7470 # - Regional external Application Load
7471 # Balancer,
7472 # - Internal proxy Network Load Balancer (load balancing
7473 # scheme INTERNAL_MANAGED),
7474 # - Regional internal Application Load
7475 # Balancer (load balancing scheme INTERNAL_MANAGED),
7476 # - Traffic
7477 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
7478 # INTERNAL_SELF_MANAGED).
7479 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
7480 # for backend services.
7481 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
7482 # created for one type of load balancer cannot be used with another.
7483 # For more information, refer toChoosing
7484 # a load balancer.
7485 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
7486 # preference. When you use localityLbPolicies, you must set at least one
7487 # value for either the localityLbPolicies[].policy or the
7488 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
7489 # value set in the localityLbPolicy field.
7490 #
7491 # For an example of how to use this field, seeDefine
7492 # a list of preferred policies.
7493 #
7494 # Caution: This field and its children are intended for use in a service mesh
7495 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
7496 # that have this configuration.
7497 { # Container for either a built-in LB policy supported by gRPC or Envoy or
7498 # a custom one implemented by the end user.
7499 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
7500 # deployed with the client.
7501 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
7502 # by a locally installed custom policy implementation.
7503 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
7504 #
7505 # The value should match the name of a custom implementation registered
7506 # on the gRPC clients. It should follow protocol buffer message naming
7507 # conventions and include the full path (for example,
7508 # myorg.CustomLbPolicy). The maximum length is 256 characters.
7509 #
7510 # Do not specify the same custom policy more than once for a
7511 # backend. If you do, the configuration is rejected.
7512 #
7513 # For an example of how to use this field, seeUse
7514 # a custom policy.
7515 },
7516 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
7517 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
7518 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
7519 # about these values, see the description of localityLbPolicy.
7520 #
7521 # Do not specify the same policy more than once for a
7522 # backend. If you do, the configuration is rejected.
7523 },
7524 },
7525 ],
7526 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
7527 # possible values are:
7528 #
7529 # - ROUND_ROBIN: This is a simple policy in which each healthy
7530 # backend is selected in round robin order. This is the default.
7531 # - LEAST_REQUEST: An O(1) algorithm which
7532 # selects two random healthy hosts and picks the host which has fewer active
7533 # requests.
7534 # - RING_HASH: The ring/modulo hash load balancer implements
7535 # consistent hashing to backends. The algorithm has the property that the
7536 # addition/removal of a host from a set of N hosts only affects 1/N of the
7537 # requests.
7538 # - RANDOM: The load balancer selects a random healthy
7539 # host.
7540 # - ORIGINAL_DESTINATION: Backend host is selected
7541 # based on the client connection metadata, i.e., connections are opened to
7542 # the same address as the destination address of the incoming connection
7543 # before the connection was redirected to the load balancer.
7544 # - MAGLEV: used as a drop in replacement for the ring hash
7545 # load balancer. Maglev is not as stable as ring hash but has faster table
7546 # lookup build times and host selection times. For more information about
7547 # Maglev, see Maglev:
7548 # A Fast and Reliable Software Network Load Balancer.
7549 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
7550 # Load Balancing using weights computed from Backend reported Custom Metrics.
7551 # If set, the Backend Service responses are expected to contain non-standard
7552 # HTTP response header field Endpoint-Load-Metrics. The reported
7553 # metrics to use for computing the weights are specified via thecustomMetrics field.
7554 #
7555 # This field is applicable to either:
7556 # - A regional backend service with the service protocol set to HTTP,
7557 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7558 # INTERNAL_MANAGED.
7559 # - A global backend service with the
7560 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
7561 # EXTERNAL_MANAGED.
7562 #
7563 #
7564 # If sessionAffinity is not configured—that is, if session
7565 # affinity remains at the default value of NONE—then the
7566 # default value for localityLbPolicy
7567 # is ROUND_ROBIN. If session affinity is set to a value other
7568 # than NONE,
7569 # then the default value for localityLbPolicy isMAGLEV.
7570 #
7571 # Only ROUND_ROBIN and RING_HASH are supported
7572 # when the backend service is referenced by a URL map that is bound to
7573 # target gRPC proxy that has validateForProxyless field set to true.
7574 #
7575 # localityLbPolicy cannot be specified with haPolicy.
7576 &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
7577 # by this backend service. If logging is enabled, logs will be exported to
7578 # Stackdriver.
7579 # backend service.
7580 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
7581 # traffic served by this backend service. The default value is false.
7582 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
7583 { # Determines which HTTP headers will be logged to Stackdriver.
7584 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7585 },
7586 ],
7587 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
7588 { # Determines which HTTP headers will be logged to Stackdriver.
7589 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7590 },
7591 ],
7592 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
7593 # This field can only be specified if logging is enabled for this backend
7594 # service. Configures whether all, none or a subset of optional fields
7595 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
7596 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
7597 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
7598 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
7599 # of optional fields you want to include in the logs. For example:
7600 # serverInstance, serverGkeDetails.cluster,
7601 # serverGkeDetails.pod.podNamespace
7602 &quot;A String&quot;,
7603 ],
7604 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
7605 # service. Configures whether all, none or a subset of optional fields
7606 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
7607 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
7608 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
7609 # service. The value of the field must be in [0, 1]. This configures the
7610 # sampling rate of requests to the load balancer where 1.0 means all logged
7611 # requests are reported and 0.0 means no logged requests are reported. The
7612 # default value is 1.0.
7613 },
7614 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
7615 # service. Duration is computed from the beginning of the stream until the
7616 # response has been completely processed, including all retries. A stream
7617 # that does not complete in this duration is closed.
7618 #
7619 # If not specified, there will be no timeout limit, i.e. the maximum
7620 # duration is infinite.
7621 #
7622 # This value can be overridden in the PathMatcher configuration of the
7623 # UrlMap that references this backend service.
7624 #
7625 # This field is only allowed when the loadBalancingScheme of
7626 # the backend service is INTERNAL_SELF_MANAGED.
7627 # as a count of seconds and fractions of seconds at nanosecond
7628 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7629 # or &quot;month&quot;. Range is approximately 10,000 years.
7630 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7631 # Durations less than one second are represented with a 0
7632 # `seconds` field and a positive `nanos` field. Must be from 0
7633 # to 999,999,999 inclusive.
7634 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7635 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7636 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7637 },
7638 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
7639 # controller and read by the backend RCTH
7640 &quot;a_key&quot;: &quot;A String&quot;,
7641 },
7642 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7643 # The name must be 1-63 characters long, and comply withRFC1035.
7644 # Specifically, the name must be 1-63 characters long and match the regular
7645 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7646 # character must be a lowercase letter, and all following characters must
7647 # be a dash, lowercase letter, or digit, except the last character, which
7648 # cannot be a dash.
7649 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
7650 #
7651 # This field must be set for Internal Passthrough Network Load Balancers when
7652 # the haPolicy is enabled, and for External Passthrough Network Load
7653 # Balancers when the haPolicy fastIpMove is enabled.
7654 #
7655 # 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.
7656 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
7657 # Load Balancers.
7658 #
7659 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
7660 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
7661 # endpoints in the local zone.
7662 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
7663 # possible values are:
7664 #
7665 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
7666 # is disabled. The load balancer distributes new connections to all
7667 # healthy backend endpoints across all zones.
7668 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
7669 # enabled. The load balancer distributes new connections to all healthy
7670 # backend endpoints in the local zone only. If there are no healthy
7671 # backend endpoints in the local zone, the load balancer distributes
7672 # new connections to all backend endpoints in the local zone.
7673 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
7674 # enabled. The load balancer distributes new connections to all healthy
7675 # backend endpoints in the local zone only. If there aren&#x27;t enough
7676 # healthy backend endpoints in the local zone, the load balancer
7677 # distributes new connections to all healthy backend endpoints across all
7678 # zones.
7679 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
7680 # of healthy backend endpoints in a zone to the count of backend
7681 # endpoints in that same zone is equal to or above this threshold, the
7682 # load balancer distributes new connections to all healthy endpoints in
7683 # the local zone only. When the ratio of the count of healthy backend
7684 # endpoints in a zone to the count of backend endpoints in that same
7685 # zone is below this threshold, the load balancer distributes all new
7686 # connections to all healthy endpoints across all zones.
7687 },
7688 },
7689 &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.
7690 # the backend service.
7691 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
7692 # service.
7693 },
7694 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
7695 # load balancing pool of each individual proxy instance that processes the
7696 # traffic for the given backend service. If not set, this feature is
7697 # considered disabled.
7698 #
7699 # Results of the outlier detection algorithm (ejection of endpoints from the
7700 # load balancing pool and returning them back to the pool) are executed
7701 # independently by each proxy instance of the load balancer. In most cases,
7702 # more than one proxy instance handles the traffic received by a backend
7703 # service. Thus, it is possible that an unhealthy endpoint is detected and
7704 # ejected by only some of the proxies, and while this happens, other proxies
7705 # may continue to send requests to the same unhealthy endpoint until they
7706 # detect and eject the unhealthy endpoint.
7707 #
7708 # Applicable backend endpoints can be:
7709 #
7710 # - VM instances in an Instance Group
7711 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
7712 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
7713 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
7714 # Functions Services
7715 # - Private Service Connect NEGs, that resolve to
7716 # Google-managed regional API endpoints or managed services published using
7717 # Private Service Connect
7718 #
7719 #
7720 #
7721 # Applicable backend service types can be:
7722 #
7723 # - A global backend service with the loadBalancingScheme set to
7724 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
7725 # - A regional backend
7726 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
7727 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
7728 # supported for Serverless NEGs.
7729 #
7730 #
7731 #
7732 # Not supported when the backend service is referenced by a URL map that is
7733 # bound to target gRPC proxy that has validateForProxyless field set to true.
7734 # pool for the backend service.
7735 &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
7736 # or 30s.
7737 #
7738 # After a backend endpoint is returned back to the load balancing pool, it
7739 # can be ejected again in another ejection analysis. Thus, the total ejection
7740 # time is equal to the base ejection time multiplied by the number of times
7741 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
7742 # as a count of seconds and fractions of seconds at nanosecond
7743 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7744 # or &quot;month&quot;. Range is approximately 10,000 years.
7745 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7746 # Durations less than one second are represented with a 0
7747 # `seconds` field and a positive `nanos` field. Must be from 0
7748 # to 999,999,999 inclusive.
7749 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7750 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7751 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7752 },
7753 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
7754 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
7755 # return code qualifies as an error. Defaults to 5.
7756 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
7757 # connection errors that are mapped to one of those status codes) before a
7758 # consecutive gateway failure ejection occurs. Defaults to 3.
7759 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7760 # outlier status is detected through consecutive 5xx. This setting can be
7761 # used to disable ejection or to ramp it up slowly. Defaults to 0.
7762 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7763 # outlier status is detected through consecutive gateway failures. This
7764 # setting can be used to disable ejection or to ramp it up slowly. Defaults
7765 # to 100.
7766 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7767 # outlier status is detected through success rate statistics. This setting
7768 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
7769 #
7770 # Not supported when the backend service uses Serverless NEG.
7771 &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
7772 # ejections and backend endpoints being returned to service. The interval is
7773 # equal to the number of seconds as defined in
7774 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
7775 # in outlierDetection.interval.nanos. Defaults to 1 second.
7776 # as a count of seconds and fractions of seconds at nanosecond
7777 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7778 # or &quot;month&quot;. Range is approximately 10,000 years.
7779 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7780 # Durations less than one second are represented with a 0
7781 # `seconds` field and a positive `nanos` field. Must be from 0
7782 # to 999,999,999 inclusive.
7783 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7784 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7785 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7786 },
7787 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
7788 # backend service that can be ejected if the ejection conditions are met.
7789 # Defaults to 50%.
7790 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
7791 # enough request volume to detect success rate outliers. If the number of
7792 # backend endpoints is fewer than this setting, outlier detection via success
7793 # rate statistics is not performed for any backend endpoint in the load
7794 # balancing pool. Defaults to 5.
7795 #
7796 # Not supported when the backend service uses Serverless NEG.
7797 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
7798 # (as defined by the interval duration above) to include this backend
7799 # endpoint in success rate based outlier detection. If the volume is lower
7800 # than this setting, outlier detection via success rate statistics is not
7801 # performed for that backend endpoint. Defaults to 100.
7802 #
7803 # Not supported when the backend service uses Serverless NEG.
7804 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
7805 # outlier ejection. The ejection threshold is the difference between the mean
7806 # success rate, and the product of this factor and the standard deviation of
7807 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
7808 # is divided by a thousand to get a double. That is, if the desired factor
7809 # is 1.9, the runtime value should be 1900. Defaults to 1900.
7810 #
7811 # Not supported when the backend service uses Serverless NEG.
7812 },
7813 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7814 # as part of resource payload.
7815 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7816 # Tag keys and values have the same definition as resource
7817 # manager tags. The field is allowed for INSERT
7818 # only. The keys/values to set on the resource should be specified in
7819 # either ID { : } or Namespaced format
7820 # { : }.
7821 # For example the following are valid inputs:
7822 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7823 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7824 # Note:
7825 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7826 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7827 &quot;a_key&quot;: &quot;A String&quot;,
7828 },
7829 },
7830 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
7831 # the backend. The default value is 80.
7832 # For internal passthrough Network Load Balancers and external passthrough
7833 # Network Load Balancers, omit port.
7834 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
7835 # communication to the backend VMs in that group. The
7836 # named port must be [defined on each backend instance
7837 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
7838 # This parameter has no meaning if the backends are NEGs. For internal
7839 # passthrough Network Load Balancers and external passthrough Network Load
7840 # Balancers, omit port_name.
7841 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
7842 # with backends.
7843 #
7844 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
7845 # depending on the chosen load balancer or Traffic Director configuration.
7846 # Refer to the documentation for the load balancers or for Traffic Director
7847 # for more information.
7848 #
7849 # Must be set to GRPC when the backend service is referenced by a URL map
7850 # that is bound to target gRPC proxy.
7851 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
7852 # resides. This field is not applicable to global backend services.
7853 # You must specify this field as part of the HTTP request URL. It is
7854 # not settable as a field in the request body.
7855 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
7856 # backend service.
7857 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
7858 # service. This field is applicable to a global backend service with the
7859 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7860 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
7861 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
7862 # be accepted on backends, and if authenticated, which method/certificate
7863 # will set the request principal.
7864 # request principal.
7865 # The authentication settings for the backend service.
7866 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
7867 # Similar to peers, these will be evaluated in order the first valid one
7868 # will be used to set origin identity. If none of these methods pass, the
7869 # request will be rejected with authentication failed error (401). Leave the
7870 # list empty if origin authentication is not required.
7871 { # [Deprecated] Configuration for the origin authentication method.
7872 # Configuration for the origin authentication method.
7873 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
7874 # JWT configuration for origin authentication.
7875 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
7876 # will be accepted if audiences is empty.
7877 # Examples: bookstore_android.apps.googleusercontent.com,
7878 # bookstore_web.apps.googleusercontent.com
7879 &quot;A String&quot;,
7880 ],
7881 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
7882 # email address.
7883 # Examples: https://securetoken.google.com,
7884 # [email protected]
7885 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
7886 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
7887 # request. If no explicit location is specified, the following default
7888 # locations are tried in order:
7889 #
7890 # 1. The Authorization header using the Bearer schema. See `here
7891 # `_. Example:
7892 #
7893 # Authorization: Bearer .
7894 #
7895 # 2. `access_token` query parameter. See `this
7896 # `_
7897 #
7898 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
7899 # from the locations its issuer specified or from the default locations.
7900 #
7901 # This field is set if JWT is sent in a request header. This field specifies
7902 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
7903 # header format will be x-goog-iap-jwt-assertion: .
7904 { # [Deprecated] This message specifies a header location to extract JWT token.
7905 # This message specifies a header location to extract JWT token.
7906 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
7907 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
7908 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
7909 # with a space at the end.
7910 },
7911 ],
7912 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
7913 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
7914 # JWT format in the query parameter is /path?jwt_token=.
7915 &quot;A String&quot;,
7916 ],
7917 },
7918 },
7919 ],
7920 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
7921 # They will be evaluated in order the first valid one will be used to set
7922 # peer identity. If none of these methods pass, the request will be rejected
7923 # with authentication failed error (401). Leave the list empty if peer
7924 # authentication is not required.
7925 { # [Deprecated] Configuration for the peer authentication method.
7926 # Configuration for the peer authentication method.
7927 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
7928 # Configuration for the mutual Tls mode for peer authentication.
7929 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
7930 # field can be set to one of the following:
7931 # STRICT: Client certificate must be presented, connection is in TLS.
7932 # PERMISSIVE: Client certificate can be omitted, connection can be either
7933 # plaintext or TLS.
7934 },
7935 },
7936 ],
7937 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
7938 # Default value is USE_PEER. If peer (or origin) identity is not available,
7939 # either because peer/origin authentication is not defined, or failed,
7940 # principal will be left unset. In other words, binding rule does not affect
7941 # the decision to accept or reject request. This field can be set to one of
7942 # the following:
7943 # USE_PEER: Principal will be set to the identity from peer authentication.
7944 # USE_ORIGIN: Principal will be set to the identity from origin
7945 # authentication.
7946 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
7947 # identity information.
7948 # The TLS settings for the client or server.
7949 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
7950 # certificate.
7951 # Defines the mechanism to obtain the client or server certificate.
7952 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
7953 # applicable only if tlsCertificateSource is set to USE_PATH.
7954 # The paths to the mounted TLS Certificates and private key.
7955 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7956 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7957 },
7958 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
7959 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
7960 # is applicable only if tlsCertificateSource is set to USE_SDS.
7961 # The configuration to access the SDS server.
7962 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
7963 # gRPC config to access the SDS server.
7964 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
7965 # gRPC call credentials to access the SDS server.
7966 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
7967 # This field can be set to one of the following:
7968 #
7969 # - GCE_VM: The local GCE VM service account credentials are used to access
7970 # the SDS server.
7971 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
7972 # SDS server.
7973 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
7974 # FROM_PLUGIN.
7975 # Custom authenticator credentials.
7976 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
7977 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
7978 # plugin.
7979 },
7980 },
7981 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
7982 # gRPC channel credentials to access the SDS server.
7983 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
7984 # The paths to the mounted TLS Certificates and private key.
7985 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7986 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7987 },
7988 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
7989 # to one of the following:
7990 # CERTIFICATES: Use TLS certificates to access the SDS server.
7991 # GCE_VM: Use local GCE VM credentials to access the SDS server.
7992 },
7993 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
7994 },
7995 },
7996 },
7997 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
7998 # validate the client/server certificate. If omitted, the proxy will not
7999 # validate the server or client certificate.
8000 # certificate to validate the client/server certificate.
8001 # validate the client/server certificate.
8002 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
8003 # client or server certificate.
8004 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
8005 # is applicable only if tlsCertificateSource is set to USE_SDS.
8006 # The configuration to access the SDS server.
8007 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
8008 # gRPC config to access the SDS server.
8009 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
8010 # gRPC call credentials to access the SDS server.
8011 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
8012 # This field can be set to one of the following:
8013 #
8014 # - GCE_VM: The local GCE VM service account credentials are used to access
8015 # the SDS server.
8016 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
8017 # SDS server.
8018 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
8019 # FROM_PLUGIN.
8020 # Custom authenticator credentials.
8021 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
8022 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
8023 # plugin.
8024 },
8025 },
8026 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
8027 # gRPC channel credentials to access the SDS server.
8028 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
8029 # The paths to the mounted TLS Certificates and private key.
8030 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
8031 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
8032 },
8033 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
8034 # to one of the following:
8035 # CERTIFICATES: Use TLS certificates to access the SDS server.
8036 # GCE_VM: Use local GCE VM credentials to access the SDS server.
8037 },
8038 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
8039 },
8040 },
8041 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
8042 },
8043 },
8044 },
8045 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
8046 # (RBAC) config.
8047 # Authorization config defines the Role Based Access Control (RBAC) config.
8048 # method-level access control for a service.
8049 # control for a service.
8050 &quot;policies&quot;: [ # List of RbacPolicies.
8051 {
8052 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
8053 &quot;permissions&quot;: [ # The list of permissions.
8054 { # [Deprecated] All fields defined in a permission are ANDed.
8055 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
8056 { # Custom constraint that specifies a key and a list of allowed values for
8057 # Istio attributes.
8058 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
8059 &quot;values&quot;: [ # A list of allowed values.
8060 &quot;A String&quot;,
8061 ],
8062 },
8063 ],
8064 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
8065 # applies to. Exact match, prefix match, and suffix match are supported.
8066 &quot;A String&quot;,
8067 ],
8068 &quot;methods&quot;: [ # HTTP method.
8069 &quot;A String&quot;,
8070 ],
8071 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
8072 &quot;A String&quot;,
8073 ],
8074 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
8075 &quot;A String&quot;,
8076 ],
8077 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
8078 &quot;A String&quot;,
8079 ],
8080 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
8081 &quot;A String&quot;,
8082 ],
8083 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
8084 # Exact match, prefix match, and suffix match are supported.
8085 &quot;A String&quot;,
8086 ],
8087 &quot;ports&quot;: [ # Port names or numbers.
8088 &quot;A String&quot;,
8089 ],
8090 },
8091 ],
8092 &quot;principals&quot;: [ # The list of principals.
8093 { # [Deprecated] All fields defined in a principal are ANDed.
8094 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
8095 &quot;groups&quot;: [ # The groups the principal belongs to.
8096 # Exact match, prefix match, and suffix match are supported.
8097 &quot;A String&quot;,
8098 ],
8099 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
8100 &quot;A String&quot;,
8101 ],
8102 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
8103 &quot;A String&quot;,
8104 ],
8105 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
8106 &quot;A String&quot;,
8107 ],
8108 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
8109 &quot;A String&quot;,
8110 ],
8111 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
8112 &quot;A String&quot;,
8113 ],
8114 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
8115 &quot;A String&quot;,
8116 ],
8117 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
8118 # suffix match are supported for values. For example,
8119 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
8120 &quot;a_key&quot;: &quot;A String&quot;,
8121 },
8122 &quot;users&quot;: [ # The user names/IDs or service accounts.
8123 # Exact match, prefix match, and suffix match are supported.
8124 &quot;A String&quot;,
8125 ],
8126 },
8127 ],
8128 },
8129 ],
8130 },
8131 &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
8132 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
8133 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
8134 # private storage buckets that support Signature Version 4 for authentication.
8135 # The service name for generating the authentication header will always default
8136 # to &#x27;s3&#x27;.
8137 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
8138 # creating a backend that uses AWS v4 signature authentication, but will not
8139 # be returned as part of the configuration when queried with a REST API GET
8140 # request.
8141 #
8142 # @InputOnly
8143 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
8144 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
8145 # keep track of different iterations of your access key.
8146 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
8147 # the name of the region your cloud uses to host your origin. For example,
8148 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
8149 },
8150 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
8151 # that describes how clients should authenticate with this service&#x27;s
8152 # backends.
8153 #
8154 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
8155 # to INTERNAL_SELF_MANAGED.
8156 #
8157 # If left blank, communications are not encrypted.
8158 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
8159 # originating from the backend service.
8160 # the backend service.
8161 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
8162 # identity information. This field is only applicable when mode is set to
8163 # MUTUAL.
8164 # The TLS settings for the client or server.
8165 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
8166 # certificate.
8167 # Defines the mechanism to obtain the client or server certificate.
8168 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
8169 # applicable only if tlsCertificateSource is set to USE_PATH.
8170 # The paths to the mounted TLS Certificates and private key.
8171 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
8172 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
8173 },
8174 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
8175 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
8176 # is applicable only if tlsCertificateSource is set to USE_SDS.
8177 # The configuration to access the SDS server.
8178 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
8179 # gRPC config to access the SDS server.
8180 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
8181 # gRPC call credentials to access the SDS server.
8182 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
8183 # This field can be set to one of the following:
8184 #
8185 # - GCE_VM: The local GCE VM service account credentials are used to access
8186 # the SDS server.
8187 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
8188 # SDS server.
8189 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
8190 # FROM_PLUGIN.
8191 # Custom authenticator credentials.
8192 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
8193 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
8194 # plugin.
8195 },
8196 },
8197 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
8198 # gRPC channel credentials to access the SDS server.
8199 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
8200 # The paths to the mounted TLS Certificates and private key.
8201 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
8202 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
8203 },
8204 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
8205 # to one of the following:
8206 # CERTIFICATES: Use TLS certificates to access the SDS server.
8207 # GCE_VM: Use local GCE VM credentials to access the SDS server.
8208 },
8209 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
8210 },
8211 },
8212 },
8213 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
8214 # validate the client/server certificate. If omitted, the proxy will not
8215 # validate the server or client certificate.
8216 # certificate to validate the client/server certificate.
8217 # validate the client/server certificate.
8218 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
8219 # client or server certificate.
8220 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
8221 # is applicable only if tlsCertificateSource is set to USE_SDS.
8222 # The configuration to access the SDS server.
8223 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
8224 # gRPC config to access the SDS server.
8225 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
8226 # gRPC call credentials to access the SDS server.
8227 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
8228 # This field can be set to one of the following:
8229 #
8230 # - GCE_VM: The local GCE VM service account credentials are used to access
8231 # the SDS server.
8232 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
8233 # SDS server.
8234 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
8235 # FROM_PLUGIN.
8236 # Custom authenticator credentials.
8237 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
8238 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
8239 # plugin.
8240 },
8241 },
8242 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
8243 # gRPC channel credentials to access the SDS server.
8244 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
8245 # The paths to the mounted TLS Certificates and private key.
8246 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
8247 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
8248 },
8249 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
8250 # to one of the following:
8251 # CERTIFICATES: Use TLS certificates to access the SDS server.
8252 # GCE_VM: Use local GCE VM credentials to access the SDS server.
8253 },
8254 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
8255 },
8256 },
8257 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
8258 },
8259 },
8260 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
8261 # The value of this field determines how TLS is enforced. This can be set
8262 # to one of the following values: DISABLE: Do not setup a TLS connection to
8263 # the backends.
8264 # SIMPLE: Originate a TLS connection to the backends.
8265 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
8266 # client certificates for authentication.
8267 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
8268 # applicable only when mode is SIMPLE or MUTUAL.
8269 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
8270 # certificate.If specified,
8271 # the proxy will verify that the server certificate&#x27;s subject alt name
8272 # matches one of the specified values. This field is applicable only when
8273 # mode is SIMPLE or MUTUAL.
8274 &quot;A String&quot;,
8275 ],
8276 },
8277 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
8278 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
8279 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
8280 # specified values, the communication continues. Otherwise, it fails. This
8281 # additional check enables the client to verify that the server is authorized
8282 # to run the requested service.
8283 #
8284 # Note that the contents of the server
8285 # certificate&#x27;s subjectAltName field are configured by the
8286 # Public Key Infrastructure which provisions server identities.
8287 #
8288 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
8289 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
8290 # mode).
8291 &quot;A String&quot;,
8292 ],
8293 },
8294 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8295 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
8296 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
8297 #
8298 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
8299 # If set, lists of backends and health checks must be both empty.
8300 &quot;A String&quot;,
8301 ],
8302 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
8303 #
8304 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
8305 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
8306 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
8307 #
8308 # Only NONE and HEADER_FIELD are supported
8309 # when the backend service is referenced by a URL map that is bound to
8310 # target gRPC proxy that has validateForProxyless field set to true.
8311 #
8312 # For more details, see:
8313 # [Session
8314 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
8315 #
8316 # sessionAffinity cannot be specified with haPolicy.
8317 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
8318 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
8319 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8320 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8321 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8322 # as a count of seconds and fractions of seconds at nanosecond
8323 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8324 # or &quot;month&quot;. Range is approximately 10,000 years.
8325 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8326 # Durations less than one second are represented with a 0
8327 # `seconds` field and a positive `nanos` field. Must be from 0
8328 # to 999,999,999 inclusive.
8329 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8330 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8331 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8332 },
8333 },
8334 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
8335 # Currently this is applicable only for Internal TCP/UDP load balancing,
8336 # Internal HTTP(S) load balancing and Traffic Director.
8337 &quot;policy&quot;: &quot;A String&quot;,
8338 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
8339 # each service mesh client.
8340 #
8341 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
8342 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
8343 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
8344 # `INTERNAL_SELF_MANAGED`.
8345 #
8346 # `subset_size` is optional for Internal HTTP(S) load balancing
8347 # and required for Traffic Director.
8348 #
8349 # If you do not provide this value, Cloud Load Balancing will calculate it
8350 # dynamically to optimize the number of proxies/clients visible to each
8351 # backend and vice versa.
8352 #
8353 # Must be greater than 0. If `subset_size` is larger than the number of
8354 # backends/endpoints, then subsetting is disabled.
8355 },
8356 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
8357 # type of load balancer. For more information see,
8358 # Backend service settings.
8359 # The default is 30 seconds.
8360 # The full range of timeout values allowed goes from 1
8361 # through 2,147,483,647 seconds.
8362 #
8363 # This value can be overridden in the PathMatcher configuration of the
8364 # UrlMap that references this backend service.
8365 #
8366 # Not supported when the backend service is referenced by a URL map that is
8367 # bound to target gRPC proxy that has validateForProxyless field set to true.
8368 # Instead, use maxStreamDuration.
8369 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
8370 # when the backend protocol is SSL, HTTPS or HTTP2.
8371 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
8372 # networksecurity.googleapis.com namespace. Can be used in authenticating
8373 # TLS connections to the backend, as specified by the authenticationMode
8374 # field. Can only be specified if authenticationMode is not NONE.
8375 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
8376 #
8377 #
8378 # Use this property to configure the load balancer back-end to use
8379 # certificates and roots of trust provisioned by the Managed Workload
8380 # Identity system.
8381 #
8382 # The `identity` property is the
8383 # fully-specified SPIFFE ID to use in the SVID presented by the Load
8384 # Balancer Workload.
8385 #
8386 # The SPIFFE ID must be a resource starting with the
8387 # `trustDomain` property value, followed by the path to the Managed
8388 # Workload Identity.
8389 #
8390 # Supported SPIFFE ID format:
8391 #
8392 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
8393 #
8394 #
8395 # The Trust Domain within the Managed Identity must refer to a valid
8396 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
8397 # will be inherited from the Workload Identity Pool.
8398 #
8399 # Restrictions:
8400 #
8401 # - If you set the `identity` property, you cannot manually set
8402 # the following fields:
8403 # - tlsSettings.sni
8404 # - tlsSettings.subjectAltNames
8405 # - tlsSettings.authenticationConfig
8406 #
8407 #
8408 # When defining a `identity` for a RegionBackendServices, the
8409 # corresponding Workload Identity Pool must have a ca_pool
8410 # configured in the same region.
8411 #
8412 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
8413 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
8414 # balancer sends this string as the SNI hostname in the TLS connection to
8415 # the backend, and requires that this string match a Subject Alternative
8416 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
8417 # NEG backend, if the SNI is specified here, the load balancer uses it
8418 # regardless of whether the Regional Internet NEG is specified with FQDN or
8419 # IP address and port. When both sni and subjectAltNames[] are specified,
8420 # the load balancer matches the backend certificate&#x27;s SAN only to
8421 # subjectAltNames[].
8422 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
8423 # verifies during a TLS handshake with the backend. When the server
8424 # presents its X.509 certificate to the Load Balancer, the Load Balancer
8425 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
8426 # match one of the subjectAltNames in the list. This field is limited to 5
8427 # entries. When both sni and subjectAltNames[] are specified, the load
8428 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
8429 { # A Subject Alternative Name that the load balancer matches against the SAN
8430 # field in the TLS certificate provided by the backend, specified as either
8431 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
8432 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
8433 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
8434 },
8435 ],
8436 },
8437 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
8438 {
8439 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
8440 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
8441 # and ForwardingRule.
8442 },
8443 ],
8444 },
8445 ],
8446 &quot;kind&quot;: &quot;compute#usableBackendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend
8447 # services.
8448 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
8449 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
8450 # the query parameter pageToken in the next list request.
8451 # Subsequent list requests will have their own nextPageToken to
8452 # continue paging through the results.
8453 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
8454 &quot;warning&quot;: { # [Output Only] Informational warning message.
8455 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8456 # Engine returns NO_RESULTS_ON_PAGE if there
8457 # are no results in the response.
8458 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8459 # value format. For example:
8460 #
8461 # &quot;data&quot;: [
8462 # {
8463 # &quot;key&quot;: &quot;scope&quot;,
8464 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8465 # }
8466 {
8467 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8468 # returned. For example, for warnings where there are no results in a list
8469 # request for a particular zone, this key might be scope and
8470 # the key value might be the zone name. Other examples might be a key
8471 # indicating a deprecated resource and a suggested replacement, or a
8472 # warning about invalid network settings (for example, if an instance
8473 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8474 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8475 },
8476 ],
8477 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8478 },
8479 }</pre>
8480 </div>
8481
8482 <div class="method">
8483 <code class="details" id="listUsable_next">listUsable_next()</code>
8484 <pre>Retrieves the next page of results.
8485
8486 Args:
8487 previous_request: The request for the previous page. (required)
8488 previous_response: The response from the request for the previous page. (required)
8489
8490 Returns:
8491 A request object that you can call &#x27;execute()&#x27; on to request the next
8492 page. Returns None if there are no more items in the collection.
8493 </pre>
8494 </div>
8495
8496 <div class="method">
8497 <code class="details" id="list_next">list_next()</code>
8498 <pre>Retrieves the next page of results.
8499
8500 Args:
8501 previous_request: The request for the previous page. (required)
8502 previous_response: The response from the request for the previous page. (required)
8503
8504 Returns:
8505 A request object that you can call &#x27;execute()&#x27; on to request the next
8506 page. Returns None if there are no more items in the collection.
8507 </pre>
8508 </div>
8509
8510 <div class="method">
8511 <code class="details" id="patch">patch(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
8512 <pre>Updates the specified regional BackendService resource with the data
8513 included in the request. For more information, see
8514 Understanding backend services This method
8515 supports PATCH semantics and uses the JSON merge
8516 patch format and processing rules.
8517
8518 Args:
8519 project: string, Project ID for this request. (required)
8520 region: string, Name of the region scoping this request. (required)
8521 backendService: string, Name of the BackendService resource to patch. (required)
8522 body: object, The request body.
8523 The object takes the form of:
8524
8525 { # Represents a Backend Service resource.
8526 #
8527 # A backend service defines how Google Cloud load balancers distribute traffic.
8528 # The backend service configuration contains a set of values, such as the
8529 # protocol used to connect to backends, various distribution and session
8530 # settings, health checks, and timeouts. These settings provide fine-grained
8531 # control over how your load balancer behaves. Most of the settings have
8532 # default values that allow for easy configuration if you need to get started
8533 # quickly.
8534 #
8535 # Backend services in Google Compute Engine can be either regionally or
8536 # globally scoped.
8537 #
8538 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
8539 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
8540 #
8541 # For more information, seeBackend
8542 # Services.
8543 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
8544 # Load Balancers and Traffic Director and requires
8545 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
8546 #
8547 # If set to 0, the cookie is non-persistent and lasts only until
8548 # the end of the browser session (or equivalent). The maximum allowed value
8549 # is two weeks (1,209,600).
8550 #
8551 # Not supported when the backend service is referenced by a URL map that is
8552 # bound to target gRPC proxy that has validateForProxyless field set to true.
8553 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
8554 # load balancing scheme set to INTERNAL_SELF_MANAGED.
8555 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
8556 { # Message containing information of one individual backend.
8557 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
8558 # handle additional traffic or is fully loaded. For usage guidelines, see
8559 # Connection balancing mode.
8560 #
8561 # Backends must use compatible balancing modes. For more information, see
8562 # Supported balancing modes and target capacity settings and
8563 # Restrictions and guidance for instance groups.
8564 #
8565 # Note: Currently, if you use the API to configure incompatible balancing
8566 # modes, the configuration might be accepted even though it has no impact
8567 # and is ignored. Specifically, Backend.maxUtilization is ignored when
8568 # Backend.balancingMode is RATE. In the future, this incompatible combination
8569 # will be rejected.
8570 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
8571 # mode.
8572 # The default value is 1, which means the group serves up to
8573 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
8574 # completely drained, offering 0% of its available capacity. The valid ranges
8575 # are 0.0 and [0.1,1.0].
8576 # You cannot configure a setting larger than 0 and smaller than0.1.
8577 # You cannot configure a setting of 0 when there is only one
8578 # backend attached to the backend service.
8579 #
8580 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
8581 # internet NEGs, regional serverless NEGs, and PSC NEGs.
8582 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
8583 # BalancingMode.
8584 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
8585 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
8586 # Monitoring, but is not used for load balancing.
8587 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
8588 # balancing mode. The valid range is [0.0, 1.0].
8589 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8590 # long and match the regular expression
8591 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8592 # first character must be a lowercase letter, and all following
8593 # characters must be a dash, period, underscore, lowercase letter, or
8594 # digit, except the last character, which cannot be a dash, period, or
8595 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8596 # field can only be used for a global or regional backend service with the
8597 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8598 },
8599 ],
8600 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8601 # create the resource.
8602 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
8603 # failover backend can be configured for a given BackendService.
8604 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
8605 # group or network endpoint
8606 # group (NEG) resource. To determine what types of backends a load
8607 # balancer supports, see the [Backend services
8608 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
8609 #
8610 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
8611 # or NEG. Partial URLs are not supported.
8612 #
8613 # If haPolicy is specified, backends must refer to NEG resources of type
8614 # GCE_VM_IP.
8615 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8616 # guidelines, seeConnection
8617 # balancing mode and Utilization
8618 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
8619 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8620 # guidelines, seeConnection
8621 # balancing mode and Utilization
8622 # balancing mode.
8623 #
8624 # Not available if the backend&#x27;s balancingMode isRATE.
8625 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
8626 # For usage guidelines, seeConnection
8627 # balancing mode and Utilization
8628 # balancing mode.
8629 #
8630 # Not available if the backend&#x27;s balancingMode isRATE.
8631 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
8632 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
8633 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
8634 # Not available if backend&#x27;s balancingMode is RATE
8635 # or CONNECTION.
8636 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
8637 # Not available if backend&#x27;s balancingMode is RATE
8638 # or CONNECTION.
8639 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
8640 # usage guidelines, seeRate
8641 # balancing mode and Utilization
8642 # balancing mode.
8643 #
8644 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8645 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8646 # guidelines, seeRate
8647 # balancing mode and Utilization
8648 # balancing mode.
8649 #
8650 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8651 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8652 # guidelines, seeRate
8653 # balancing mode and Utilization
8654 # balancing mode.
8655 #
8656 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8657 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
8658 #
8659 # For usage guidelines, seeUtilization
8660 # balancing mode.
8661 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
8662 # the backend.
8663 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
8664 },
8665 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
8666 # sending traffic to backends with default preference. The possible values
8667 # are:
8668 #
8669 # - PREFERRED: Backends with this preference level will be
8670 # filled up to their capacity limits first, based on RTT.
8671 # - DEFAULT: If preferred backends don&#x27;t have enough
8672 # capacity, backends in this layer would be used and traffic would be
8673 # assigned based on the load balancing algorithm you use. This is the
8674 # default
8675 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
8676 # Attachment).
8677 # e.g.
8678 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
8679 # for Cloud Run service.
8680 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
8681 # for PSC Service Attachment.
8682 &quot;trafficDuration&quot;: &quot;A String&quot;,
8683 },
8684 ],
8685 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
8686 # specified load balancer types.
8687 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
8688 # Pragma or Authorization headers. Up to 5 headers can be specified.
8689 # The cache is bypassed for all cdnPolicy.cacheMode settings.
8690 { # Bypass the cache when the specified request headers are present,
8691 # e.g. Pragma or Authorization headers. Values are case insensitive.
8692 # The presence of such a header overrides the cache_mode setting.
8693 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
8694 # Values are case-insensitive.
8695 },
8696 ],
8697 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
8698 # CDN.
8699 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
8700 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
8701 &quot;A String&quot;,
8702 ],
8703 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
8704 # The name=value pair will be used in the cache key Cloud CDN generates.
8705 &quot;A String&quot;,
8706 ],
8707 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
8708 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
8709 # query_string_whitelist and query_string_blacklist. If neither is set, the
8710 # entire query string will be included. If false, the query string will be
8711 # excluded from the cache key entirely.
8712 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
8713 # parameters will be included. Either specify query_string_whitelist or
8714 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8715 # not treated as delimiters.
8716 &quot;A String&quot;,
8717 ],
8718 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
8719 # parameters will be excluded. Either specify query_string_whitelist or
8720 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8721 # not treated as delimiters.
8722 &quot;A String&quot;,
8723 ],
8724 },
8725 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
8726 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
8727 # headers to cache content. Responses without these headers will not be
8728 # cached at Google&#x27;s edge, and will require a full trip to the origin on
8729 # every request, potentially impacting performance and increasing load on
8730 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
8731 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
8732 # Warning: this may result in Cloud CDN caching private,
8733 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
8734 # including common image formats, media (video and audio), and web assets
8735 # (JavaScript and CSS). Requests and responses that are marked as
8736 # uncacheable, as well as dynamic content (including HTML), will not be
8737 # cached.
8738 #
8739 # If no value is provided for cdnPolicy.cacheMode, it defaults
8740 # to CACHE_ALL_STATIC.
8741 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
8742 # used to clamp the max-age (or Expires) value sent to the client. With
8743 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
8744 # response max-age directive, along with a &quot;public&quot; directive. For
8745 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
8746 # from the origin (if specified), or else sets the response max-age
8747 # directive to the lesser of the client_ttl and default_ttl, and also
8748 # ensures a &quot;public&quot; cache-control directive is present.
8749 # If a client TTL is not specified, a default value (1 hour) will be used.
8750 # The maximum allowed value is 31,622,400s (1 year).
8751 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
8752 # responses that do not have an existing valid TTL (max-age or s-maxage).
8753 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8754 # The value of defaultTTL cannot be set to a value greater than that of
8755 # maxTTL, but can be equal.
8756 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
8757 # will overwrite the TTL set in all responses. The maximum allowed value is
8758 # 31,622,400s (1 year), noting that infrequently accessed objects may be
8759 # evicted from the cache before the defined TTL.
8760 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
8761 # origin.
8762 # Cache directives that attempt to set a max-age or s-maxage higher than
8763 # this, or an Expires header more than maxTTL seconds in the future will
8764 # be capped at the value of maxTTL, as if it were the value of an
8765 # s-maxage Cache-Control directive.
8766 # Headers sent to the client will not be modified.
8767 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8768 # The maximum allowed value is 31,622,400s (1 year), noting that
8769 # infrequently accessed objects may be evicted from the cache before
8770 # the defined TTL.
8771 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
8772 # to apply fine-grained caching for common errors or redirects.
8773 # This can reduce the load on your origin and improve end-user
8774 # experience by reducing response latency.
8775 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
8776 # negative caching applies to responses with the specified response code
8777 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
8778 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
8779 # to all responses with the specified response code, and override any
8780 # caching headers.
8781 # By default, Cloud CDN will apply the following default TTLs to these
8782 # status codes:
8783 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
8784 # HTTP 404 (Not Found), 410 (Gone),
8785 # 451 (Unavailable For Legal Reasons): 120s
8786 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
8787 # These defaults can be overridden in negative_caching_policy.
8788 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
8789 # negative_caching must be enabled to configure negative_caching_policy.
8790 # Omitting the policy and leaving negative_caching enabled will use
8791 # Cloud CDN&#x27;s default cache TTLs.
8792 # Note that when specifying an explicit negative_caching_policy, you
8793 # should take care to specify a cache TTL for all response codes
8794 # that you wish to cache. Cloud CDN will not apply any default
8795 # negative caching when a policy exists.
8796 { # Specify CDN TTLs for response error codes.
8797 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
8798 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
8799 # specified as values, and you cannot specify a status code more than
8800 # once.
8801 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
8802 # corresponding status code.
8803 # The maximum allowed value is 1800s (30 minutes), noting that
8804 # infrequently accessed objects may be evicted from the cache before the
8805 # defined TTL.
8806 },
8807 ],
8808 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
8809 # requests into a small number of requests to the origin.
8810 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
8811 # content with the origin, or when an error is encountered when refreshing
8812 # the cache.
8813 # This setting defines the default &quot;max-stale&quot; duration for any cached
8814 # responses that do not specify a max-stale directive. Stale responses that
8815 # exceed the TTL configured here will not be served. The default limit
8816 # (max-stale) is 86400s (1 day), which will allow stale content to be
8817 # served up to this limit beyond the max-age (or s-maxage) of a cached
8818 # response.
8819 # The maximum allowed value is 604800 (1 week).
8820 # Set this to zero (0) to disable serve-while-stale.
8821 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
8822 # considered fresh. After this time period, the response will be
8823 # revalidated before being served. Defaults to 1hr (3600s). When serving
8824 # responses to signed URL requests, Cloud CDN will internally behave as
8825 # though all responses from this backend had a &quot;Cache-Control:
8826 # public, max-age=[TTL]&quot; header, regardless of any existing
8827 # Cache-Control header. The actual headers served in responses will not be
8828 # altered.
8829 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
8830 &quot;A String&quot;,
8831 ],
8832 },
8833 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
8834 # backend service.
8835 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
8836 # as a count of seconds and fractions of seconds at nanosecond
8837 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8838 # or &quot;month&quot;. Range is approximately 10,000 years.
8839 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8840 # Durations less than one second are represented with a 0
8841 # `seconds` field and a positive `nanos` field. Must be from 0
8842 # to 999,999,999 inclusive.
8843 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8844 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8845 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8846 },
8847 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
8848 # there is no limit.
8849 #
8850 # Not supported when the backend service is referenced by a URL map that is
8851 # bound to target gRPC proxy that has validateForProxyless field set to true.
8852 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
8853 # not specified, there is no limit.
8854 #
8855 # Not supported when the backend service is referenced by a URL map that is
8856 # bound to target gRPC proxy that has validateForProxyless field set to true.
8857 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
8858 # service. If not specified, there is no limit.
8859 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
8860 # This parameter is respected by both the HTTP/1.1 and HTTP/2
8861 # implementations. If not specified, there is no limit. Setting this
8862 # parameter to 1 will effectively disable keep alive.
8863 #
8864 # Not supported when the backend service is referenced by a URL map that is
8865 # bound to target gRPC proxy that has validateForProxyless field set to true.
8866 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
8867 # not specified, the default is 1.
8868 #
8869 # Not supported when the backend service is referenced by a URL map that is
8870 # bound to target gRPC proxy that has validateForProxyless field set to true.
8871 },
8872 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
8873 # the client&#x27;s Accept-Encoding header.
8874 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
8875 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
8876 # instance. For supported load balancers and protocols, as described inEnabling
8877 # connection draining.
8878 },
8879 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
8880 # tracking policy settings are only available for external passthrough
8881 # Network Load Balancers and internal passthrough Network Load Balancers.
8882 #
8883 # connectionTrackingPolicy cannot be specified with haPolicy.
8884 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
8885 # value is DEFAULT_FOR_PROTOCOL.
8886 #
8887 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
8888 # persist on unhealthy backends only for connection-oriented protocols
8889 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
8890 # Affinity is configured for 5-tuple. They do not persist forUDP.
8891 #
8892 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
8893 # the existing connections on the unhealthy backend are never persisted on
8894 # the unhealthy backend. They are always diverted to newly selected healthy
8895 # backends (unless all backends are unhealthy).
8896 #
8897 # If set to ALWAYS_PERSIST, existing connections always
8898 # persist on unhealthy backends regardless of protocol and session
8899 # affinity. It is generally not recommended to use this mode overriding the
8900 # default.
8901 #
8902 # For more details, see [Connection Persistence for Network Load
8903 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
8904 # and [Connection Persistence for Internal TCP/UDP Load
8905 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
8906 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
8907 # Balancers. This option is not available publicly.
8908 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
8909 # matching traffic (in seconds).
8910 #
8911 # For internal passthrough Network Load Balancers:
8912 #
8913 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
8914 # - It can be set only if Connection Tracking is less than 5-tuple
8915 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
8916 # Mode is PER_SESSION).
8917 #
8918 #
8919 #
8920 # For external passthrough Network Load Balancers the default is 60
8921 # seconds. This option is not available publicly.
8922 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
8923 # options:
8924 #
8925 # - PER_CONNECTION: This is the default mode. The Connection
8926 # Tracking is performed as per the Connection Key (default Hash Method) for
8927 # the specific protocol.
8928 # - PER_SESSION: The Connection Tracking is performed as per
8929 # the configured Session Affinity. It matches the configured Session
8930 # Affinity.
8931 #
8932 #
8933 #
8934 # For more details, see [Tracking Mode for Network Load
8935 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
8936 # and [Tracking Mode for Internal TCP/UDP Load
8937 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
8938 },
8939 &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
8940 # affinity based on HTTP headers, cookies or other properties. This load
8941 # balancing policy is applicable only for HTTP connections. The affinity to a
8942 # particular destination host will be lost when one or more hosts are
8943 # added/removed from the destination service. This field specifies parameters
8944 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
8945 #
8946 # This field is applicable to either:
8947 #
8948 # - A regional backend service with the service protocol set to HTTP,
8949 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
8950 # INTERNAL_MANAGED.
8951 # - A global backend service with the
8952 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
8953 &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
8954 # be used as the hash key for the consistent hash load balancer. If the
8955 # cookie is not present, it will be generated. This field is applicable if
8956 # the sessionAffinity is set to HTTP_COOKIE.
8957 #
8958 # Not supported when the backend service is referenced by a URL map that is
8959 # bound to target gRPC proxy that has validateForProxyless field set to true.
8960 # for load balancing policies that use a consistent hash.
8961 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8962 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8963 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8964 # as a count of seconds and fractions of seconds at nanosecond
8965 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8966 # or &quot;month&quot;. Range is approximately 10,000 years.
8967 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8968 # Durations less than one second are represented with a 0
8969 # `seconds` field and a positive `nanos` field. Must be from 0
8970 # to 999,999,999 inclusive.
8971 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8972 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8973 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8974 },
8975 },
8976 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
8977 # applicable if the sessionAffinity is set toHEADER_FIELD.
8978 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
8979 # 1024. Larger ring sizes result in more granular load distributions. If the
8980 # number of hosts in the load balancing pool is larger than the ring size,
8981 # each host will be assigned a single virtual node.
8982 },
8983 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8984 # text format.
8985 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
8986 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
8987 # locality_lb_policy.
8988 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
8989 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8990 # long and match the regular expression
8991 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8992 # first character must be a lowercase letter, and all following
8993 # characters must be a dash, period, underscore, lowercase letter, or
8994 # digit, except the last character, which cannot be a dash, period, or
8995 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8996 # field can only be used for a global or regional backend service with the
8997 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8998 },
8999 ],
9000 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
9001 # custom
9002 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
9003 &quot;A String&quot;,
9004 ],
9005 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
9006 # custom
9007 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
9008 &quot;A String&quot;,
9009 ],
9010 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9011 # create the resource.
9012 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
9013 # backend service with dynamic forwarding feature which together with Service
9014 # Extension allows customized and complex routing logic.
9015 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
9016 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
9017 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
9018 },
9019 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
9020 # service. Some ranges are restricted: Restricted
9021 # ranges.
9022 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
9023 },
9024 },
9025 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
9026 # this backend service.
9027 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
9028 # global external Application Load Balancer.
9029 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
9030 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
9031 #
9032 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
9033 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
9034 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
9035 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
9036 # externalManagedMigrationTestingPercentage.
9037 #
9038 # Rolling back a migration requires the states to be set in reverse order. So
9039 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
9040 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
9041 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
9042 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
9043 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
9044 # external Application Load Balancer.
9045 #
9046 # The value of this field must be in the range [0, 100].
9047 #
9048 # Session affinity options will slightly affect this routing behavior, for
9049 # more details, see:Session
9050 # Affinity.
9051 #
9052 # This value can only be set if the loadBalancingScheme in the BackendService
9053 # is set to EXTERNAL (when using the classic Application Load Balancer) and
9054 # the migration state is TEST_BY_PERCENTAGE.
9055 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
9056 # as a backup (failover) backend.
9057 # For load balancers that have configurable failover:
9058 # [Internal passthrough Network Load
9059 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9060 # and [external passthrough Network Load
9061 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9062 #
9063 # failoverPolicy cannot be specified with haPolicy.
9064 # failover:
9065 # [Internal passthrough Network Load
9066 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9067 # and [external passthrough
9068 # Network Load
9069 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9070 # On failover or failback, this field indicates whether connection draining
9071 # will be honored. Google Cloud has a fixed connection draining timeout of
9072 # 10 minutes. A setting of true terminates existing TCP
9073 # connections to the active pool during failover and failback, immediately
9074 # draining traffic. A setting of false allows existing TCP
9075 # connections to persist, even on VMs no longer in the active pool, for up
9076 # to the duration of the connection draining timeout (10 minutes).
9077 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
9078 #
9079 # The default is false.
9080 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
9081 # load balancer are dropped when all primary and all backup backend VMs are
9082 # unhealthy.If set to false, connections are distributed
9083 # among all primary VMs when all primary and all backup backend VMs are
9084 # unhealthy.
9085 # For load balancers that have configurable
9086 # failover:
9087 # [Internal passthrough
9088 # Network Load
9089 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9090 # and [external passthrough
9091 # Network Load
9092 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9093 # The default is false.
9094 &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
9095 # failover when the number of healthy primary VMs equals zero.
9096 # For all other values, the load balancer performs a failover when the
9097 # total number of healthy primary VMs is less than this ratio.
9098 # For load balancers that have configurable
9099 # failover:
9100 # [Internal TCP/UDP Load
9101 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9102 # and [external TCP/UDP Load
9103 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9104 },
9105 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
9106 # This field is used in optimistic locking. This field will be ignored when
9107 # inserting a BackendService. An up-to-date fingerprint must be provided in
9108 # order to update the BackendService, otherwise the request will
9109 # fail with error 412 conditionNotMet.
9110 #
9111 # To see the latest fingerprint, make a get() request to
9112 # retrieve a BackendService.
9113 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
9114 # Protocol Forwarding.
9115 #
9116 # The backends of this regional backend service must only specify zonal
9117 # network endpoint groups (NEGs) of type GCE_VM_IP.
9118 #
9119 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
9120 # regional backend service must set the network field. All zonal NEGs must
9121 # belong to the same network. However, individual NEGs can
9122 # belong to different subnetworks of that network.
9123 #
9124 # When haPolicy is specified, the set of attached network endpoints across
9125 # all backends comprise an High Availability domain from which one endpoint
9126 # is selected as the active endpoint (the leader) that receives all
9127 # traffic.
9128 #
9129 # haPolicy can be added only at backend service creation time. Once set up,
9130 # it cannot be deleted.
9131 #
9132 # Note that haPolicy is not for load balancing, and therefore cannot be
9133 # specified with sessionAffinity, connectionTrackingPolicy, and
9134 # failoverPolicy.
9135 #
9136 # haPolicy requires customers to be responsible for tracking backend
9137 # endpoint health and electing a leader among the healthy endpoints.
9138 # Therefore, haPolicy cannot be specified with healthChecks.
9139 #
9140 # haPolicy can only be specified for External Passthrough Network Load
9141 # Balancers and Internal Passthrough Network Load Balancers.
9142 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
9143 # achieve it.
9144 #
9145 # Supported values are:
9146 #
9147 # - DISABLED: Fast IP Move is disabled. You can only use the
9148 # haPolicy.leader API to update the leader.
9149 # - &gt;GARP_RA: Provides a method to very quickly define a new network
9150 # endpoint as the leader. This method is faster than updating the leader
9151 # using the haPolicy.leader API. Fast IP move works as follows: The VM
9152 # hosting the network endpoint that should become the new leader sends
9153 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
9154 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
9155 # temporarily associates the forwarding rule IP address with that VM, and
9156 # both new and in-flight packets are quickly delivered to that VM.
9157 #
9158 #
9159 #
9160 # Note the important properties of the Fast IP Move functionality:
9161 #
9162 # - The GARP/RA-initiated re-routing stays active for approximately 20
9163 # minutes. After triggering fast failover, you must also
9164 # appropriately set the haPolicy.leader.
9165 # - The new leader instance should continue to send GARP/RA packets
9166 # periodically every 10 seconds until at least 10 minutes after updating
9167 # the haPolicy.leader (but stop immediately if it is no longer the leader).
9168 # - After triggering a fast failover, we recommend that you wait at least
9169 # 3 seconds before sending another GARP/RA packet from a different VM
9170 # instance to avoid race conditions.
9171 # - Don&#x27;t send GARP/RA packets from different VM
9172 # instances at the same time. If multiple instances continue to send
9173 # GARP/RA packets, traffic might be routed to different destinations in an
9174 # alternating order. This condition ceases when a single instance
9175 # issues a GARP/RA packet.
9176 # - The GARP/RA request always takes priority over the leader API.
9177 # Using the haPolicy.leader API to change the leader to a different
9178 # instance will have no effect until the GARP/RA request becomes
9179 # inactive.
9180 # - The GARP/RA packets should follow the GARP/RA
9181 # Packet Specifications..
9182 # - When multiple forwarding rules refer to a regional backend service,
9183 # you need only send a GARP or RA packet for a single forwarding rule
9184 # virtual IP. The virtual IPs for all forwarding rules targeting the same
9185 # backend service will also be moved to the sender of the GARP or RA
9186 # packet.
9187 #
9188 #
9189 #
9190 # The following are the Fast IP Move limitations (that is, when fastIPMove
9191 # is not DISABLED):
9192 #
9193 # - Multiple forwarding rules cannot use the same IP address if one of
9194 # them refers to a regional backend service with fastIPMove.
9195 # - The regional backend service must set the network field, and all
9196 # NEGs must belong to that network. However, individual
9197 # NEGs can belong to different subnetworks of that network.
9198 # - The maximum number of network endpoints across all backends of a
9199 # backend service with fastIPMove is 32.
9200 # - The maximum number of backend services with fastIPMove that can have
9201 # the same network endpoint attached to one of its backends is 64.
9202 # - The maximum number of backend services with fastIPMove in a VPC in a
9203 # region is 64.
9204 # - The network endpoints that are attached to a backend of a backend
9205 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
9206 # - Traffic directed to the leader by a static route next hop will not be
9207 # redirected to a new leader by fast failover. Such traffic will only be
9208 # redirected once an haPolicy.leader update has taken effect. Only traffic
9209 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
9210 # fast failover.
9211 #
9212 #
9213 # haPolicy.fastIPMove can be set only at backend service creation time.
9214 # Once set, it cannot be updated.
9215 #
9216 # By default, fastIpMove is set to DISABLED.
9217 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
9218 # this service as the active endpoint (the leader) that receives all
9219 # traffic.
9220 #
9221 # When the leader changes, there is no connection draining to persist
9222 # existing connections on the old leader.
9223 #
9224 # You are responsible for selecting a suitable endpoint as the
9225 # leader. For example, preferring a healthy endpoint over unhealthy ones.
9226 # Note that this service does not track backend endpoint health, and
9227 # selects the configured leader unconditionally.
9228 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
9229 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
9230 # that the leader is attached to.
9231 #
9232 # The leader&#x27;s backendGroup must already be specified as a backend of
9233 # this backend service. Removing a backend that is designated as the
9234 # leader&#x27;s backendGroup is not permitted.
9235 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
9236 # designated as the leader.
9237 #
9238 # This network endpoint cannot be detached from the NEG specified in
9239 # the haPolicy.leader.backendGroup until the leader is updated with
9240 # another network endpoint, or the leader is removed from the haPolicy.
9241 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
9242 # instance must already be attached to the NEG specified in the
9243 # haPolicy.leader.backendGroup.
9244 #
9245 # The name must be 1-63 characters long, and comply with RFC1035.
9246 # Authorization requires the following IAM permission on the
9247 # specified resource instance: compute.instances.use
9248 },
9249 },
9250 },
9251 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
9252 # httpsHealthChecks (legacy) resource for health checking this backend
9253 # service. Not all backend services support legacy health checks. See
9254 # Load balancer guide. Currently, at most one health check can be
9255 # specified for each backend service. Backend services with
9256 # instance group or zonal NEG backends must have a health check unless
9257 # haPolicy is specified. Backend services with internet or serverless NEG
9258 # backends must not have a health check.
9259 #
9260 # healthChecks[] cannot be specified with haPolicy.
9261 &quot;A String&quot;,
9262 ],
9263 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
9264 # Not available for internal passthrough Network Load Balancers and external
9265 # passthrough Network Load Balancers.
9266 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
9267 # incoming requests.
9268 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
9269 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
9270 # for IAP.
9271 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
9272 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
9273 # Optional - If not provided, the name will be autogenerated by the
9274 # backend.
9275 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
9276 },
9277 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
9278 # For security reasons, this value cannot be retrieved via the API.
9279 # Instead, the SHA-256 hash of the value is returned in the
9280 # oauth2ClientSecretSha256 field.
9281 #
9282 # @InputOnly
9283 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
9284 },
9285 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
9286 # defined by the server.
9287 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
9288 # from the client to the backend for proxyless gRPC).
9289 # The possible values are:
9290 #
9291 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
9292 # backend service (Instance Group, Managed Instance Group, Network Endpoint
9293 # Group), regardless of traffic from the client to the proxy. Only IPv4
9294 # health checks are used to check the health of the backends. This is the
9295 # default setting.
9296 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
9297 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
9298 # address).
9299 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
9300 # backend service (Instance Group, Managed Instance Group, Network Endpoint
9301 # Group), regardless of traffic from the client to the proxy. Only IPv6
9302 # health checks are used to check the health of the backends.
9303 #
9304 #
9305 #
9306 # This field is applicable to either:
9307 #
9308 # - Advanced global external Application Load Balancer (load balancing
9309 # scheme EXTERNAL_MANAGED),
9310 # - Regional external Application Load
9311 # Balancer,
9312 # - Internal proxy Network Load Balancer (load balancing
9313 # scheme INTERNAL_MANAGED),
9314 # - Regional internal Application Load
9315 # Balancer (load balancing scheme INTERNAL_MANAGED),
9316 # - Traffic
9317 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
9318 # INTERNAL_SELF_MANAGED).
9319 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
9320 # for backend services.
9321 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
9322 # created for one type of load balancer cannot be used with another.
9323 # For more information, refer toChoosing
9324 # a load balancer.
9325 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
9326 # preference. When you use localityLbPolicies, you must set at least one
9327 # value for either the localityLbPolicies[].policy or the
9328 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
9329 # value set in the localityLbPolicy field.
9330 #
9331 # For an example of how to use this field, seeDefine
9332 # a list of preferred policies.
9333 #
9334 # Caution: This field and its children are intended for use in a service mesh
9335 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
9336 # that have this configuration.
9337 { # Container for either a built-in LB policy supported by gRPC or Envoy or
9338 # a custom one implemented by the end user.
9339 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
9340 # deployed with the client.
9341 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
9342 # by a locally installed custom policy implementation.
9343 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
9344 #
9345 # The value should match the name of a custom implementation registered
9346 # on the gRPC clients. It should follow protocol buffer message naming
9347 # conventions and include the full path (for example,
9348 # myorg.CustomLbPolicy). The maximum length is 256 characters.
9349 #
9350 # Do not specify the same custom policy more than once for a
9351 # backend. If you do, the configuration is rejected.
9352 #
9353 # For an example of how to use this field, seeUse
9354 # a custom policy.
9355 },
9356 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
9357 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
9358 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
9359 # about these values, see the description of localityLbPolicy.
9360 #
9361 # Do not specify the same policy more than once for a
9362 # backend. If you do, the configuration is rejected.
9363 },
9364 },
9365 ],
9366 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
9367 # possible values are:
9368 #
9369 # - ROUND_ROBIN: This is a simple policy in which each healthy
9370 # backend is selected in round robin order. This is the default.
9371 # - LEAST_REQUEST: An O(1) algorithm which
9372 # selects two random healthy hosts and picks the host which has fewer active
9373 # requests.
9374 # - RING_HASH: The ring/modulo hash load balancer implements
9375 # consistent hashing to backends. The algorithm has the property that the
9376 # addition/removal of a host from a set of N hosts only affects 1/N of the
9377 # requests.
9378 # - RANDOM: The load balancer selects a random healthy
9379 # host.
9380 # - ORIGINAL_DESTINATION: Backend host is selected
9381 # based on the client connection metadata, i.e., connections are opened to
9382 # the same address as the destination address of the incoming connection
9383 # before the connection was redirected to the load balancer.
9384 # - MAGLEV: used as a drop in replacement for the ring hash
9385 # load balancer. Maglev is not as stable as ring hash but has faster table
9386 # lookup build times and host selection times. For more information about
9387 # Maglev, see Maglev:
9388 # A Fast and Reliable Software Network Load Balancer.
9389 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
9390 # Load Balancing using weights computed from Backend reported Custom Metrics.
9391 # If set, the Backend Service responses are expected to contain non-standard
9392 # HTTP response header field Endpoint-Load-Metrics. The reported
9393 # metrics to use for computing the weights are specified via thecustomMetrics field.
9394 #
9395 # This field is applicable to either:
9396 # - A regional backend service with the service protocol set to HTTP,
9397 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
9398 # INTERNAL_MANAGED.
9399 # - A global backend service with the
9400 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
9401 # EXTERNAL_MANAGED.
9402 #
9403 #
9404 # If sessionAffinity is not configured—that is, if session
9405 # affinity remains at the default value of NONE—then the
9406 # default value for localityLbPolicy
9407 # is ROUND_ROBIN. If session affinity is set to a value other
9408 # than NONE,
9409 # then the default value for localityLbPolicy isMAGLEV.
9410 #
9411 # Only ROUND_ROBIN and RING_HASH are supported
9412 # when the backend service is referenced by a URL map that is bound to
9413 # target gRPC proxy that has validateForProxyless field set to true.
9414 #
9415 # localityLbPolicy cannot be specified with haPolicy.
9416 &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
9417 # by this backend service. If logging is enabled, logs will be exported to
9418 # Stackdriver.
9419 # backend service.
9420 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
9421 # traffic served by this backend service. The default value is false.
9422 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
9423 { # Determines which HTTP headers will be logged to Stackdriver.
9424 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9425 },
9426 ],
9427 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
9428 { # Determines which HTTP headers will be logged to Stackdriver.
9429 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9430 },
9431 ],
9432 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
9433 # This field can only be specified if logging is enabled for this backend
9434 # service. Configures whether all, none or a subset of optional fields
9435 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
9436 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
9437 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
9438 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
9439 # of optional fields you want to include in the logs. For example:
9440 # serverInstance, serverGkeDetails.cluster,
9441 # serverGkeDetails.pod.podNamespace
9442 &quot;A String&quot;,
9443 ],
9444 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
9445 # service. Configures whether all, none or a subset of optional fields
9446 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
9447 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
9448 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
9449 # service. The value of the field must be in [0, 1]. This configures the
9450 # sampling rate of requests to the load balancer where 1.0 means all logged
9451 # requests are reported and 0.0 means no logged requests are reported. The
9452 # default value is 1.0.
9453 },
9454 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
9455 # service. Duration is computed from the beginning of the stream until the
9456 # response has been completely processed, including all retries. A stream
9457 # that does not complete in this duration is closed.
9458 #
9459 # If not specified, there will be no timeout limit, i.e. the maximum
9460 # duration is infinite.
9461 #
9462 # This value can be overridden in the PathMatcher configuration of the
9463 # UrlMap that references this backend service.
9464 #
9465 # This field is only allowed when the loadBalancingScheme of
9466 # the backend service is INTERNAL_SELF_MANAGED.
9467 # as a count of seconds and fractions of seconds at nanosecond
9468 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9469 # or &quot;month&quot;. Range is approximately 10,000 years.
9470 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9471 # Durations less than one second are represented with a 0
9472 # `seconds` field and a positive `nanos` field. Must be from 0
9473 # to 999,999,999 inclusive.
9474 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9475 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9476 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9477 },
9478 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
9479 # controller and read by the backend RCTH
9480 &quot;a_key&quot;: &quot;A String&quot;,
9481 },
9482 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
9483 # The name must be 1-63 characters long, and comply withRFC1035.
9484 # Specifically, the name must be 1-63 characters long and match the regular
9485 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
9486 # character must be a lowercase letter, and all following characters must
9487 # be a dash, lowercase letter, or digit, except the last character, which
9488 # cannot be a dash.
9489 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
9490 #
9491 # This field must be set for Internal Passthrough Network Load Balancers when
9492 # the haPolicy is enabled, and for External Passthrough Network Load
9493 # Balancers when the haPolicy fastIpMove is enabled.
9494 #
9495 # 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.
9496 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
9497 # Load Balancers.
9498 #
9499 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
9500 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
9501 # endpoints in the local zone.
9502 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
9503 # possible values are:
9504 #
9505 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
9506 # is disabled. The load balancer distributes new connections to all
9507 # healthy backend endpoints across all zones.
9508 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
9509 # enabled. The load balancer distributes new connections to all healthy
9510 # backend endpoints in the local zone only. If there are no healthy
9511 # backend endpoints in the local zone, the load balancer distributes
9512 # new connections to all backend endpoints in the local zone.
9513 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
9514 # enabled. The load balancer distributes new connections to all healthy
9515 # backend endpoints in the local zone only. If there aren&#x27;t enough
9516 # healthy backend endpoints in the local zone, the load balancer
9517 # distributes new connections to all healthy backend endpoints across all
9518 # zones.
9519 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
9520 # of healthy backend endpoints in a zone to the count of backend
9521 # endpoints in that same zone is equal to or above this threshold, the
9522 # load balancer distributes new connections to all healthy endpoints in
9523 # the local zone only. When the ratio of the count of healthy backend
9524 # endpoints in a zone to the count of backend endpoints in that same
9525 # zone is below this threshold, the load balancer distributes all new
9526 # connections to all healthy endpoints across all zones.
9527 },
9528 },
9529 &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.
9530 # the backend service.
9531 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
9532 # service.
9533 },
9534 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
9535 # load balancing pool of each individual proxy instance that processes the
9536 # traffic for the given backend service. If not set, this feature is
9537 # considered disabled.
9538 #
9539 # Results of the outlier detection algorithm (ejection of endpoints from the
9540 # load balancing pool and returning them back to the pool) are executed
9541 # independently by each proxy instance of the load balancer. In most cases,
9542 # more than one proxy instance handles the traffic received by a backend
9543 # service. Thus, it is possible that an unhealthy endpoint is detected and
9544 # ejected by only some of the proxies, and while this happens, other proxies
9545 # may continue to send requests to the same unhealthy endpoint until they
9546 # detect and eject the unhealthy endpoint.
9547 #
9548 # Applicable backend endpoints can be:
9549 #
9550 # - VM instances in an Instance Group
9551 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
9552 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
9553 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
9554 # Functions Services
9555 # - Private Service Connect NEGs, that resolve to
9556 # Google-managed regional API endpoints or managed services published using
9557 # Private Service Connect
9558 #
9559 #
9560 #
9561 # Applicable backend service types can be:
9562 #
9563 # - A global backend service with the loadBalancingScheme set to
9564 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
9565 # - A regional backend
9566 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
9567 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
9568 # supported for Serverless NEGs.
9569 #
9570 #
9571 #
9572 # Not supported when the backend service is referenced by a URL map that is
9573 # bound to target gRPC proxy that has validateForProxyless field set to true.
9574 # pool for the backend service.
9575 &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
9576 # or 30s.
9577 #
9578 # After a backend endpoint is returned back to the load balancing pool, it
9579 # can be ejected again in another ejection analysis. Thus, the total ejection
9580 # time is equal to the base ejection time multiplied by the number of times
9581 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
9582 # as a count of seconds and fractions of seconds at nanosecond
9583 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9584 # or &quot;month&quot;. Range is approximately 10,000 years.
9585 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9586 # Durations less than one second are represented with a 0
9587 # `seconds` field and a positive `nanos` field. Must be from 0
9588 # to 999,999,999 inclusive.
9589 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9590 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9591 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9592 },
9593 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
9594 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
9595 # return code qualifies as an error. Defaults to 5.
9596 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
9597 # connection errors that are mapped to one of those status codes) before a
9598 # consecutive gateway failure ejection occurs. Defaults to 3.
9599 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9600 # outlier status is detected through consecutive 5xx. This setting can be
9601 # used to disable ejection or to ramp it up slowly. Defaults to 0.
9602 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9603 # outlier status is detected through consecutive gateway failures. This
9604 # setting can be used to disable ejection or to ramp it up slowly. Defaults
9605 # to 100.
9606 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9607 # outlier status is detected through success rate statistics. This setting
9608 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
9609 #
9610 # Not supported when the backend service uses Serverless NEG.
9611 &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
9612 # ejections and backend endpoints being returned to service. The interval is
9613 # equal to the number of seconds as defined in
9614 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
9615 # in outlierDetection.interval.nanos. Defaults to 1 second.
9616 # as a count of seconds and fractions of seconds at nanosecond
9617 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9618 # or &quot;month&quot;. Range is approximately 10,000 years.
9619 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9620 # Durations less than one second are represented with a 0
9621 # `seconds` field and a positive `nanos` field. Must be from 0
9622 # to 999,999,999 inclusive.
9623 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9624 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9625 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9626 },
9627 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
9628 # backend service that can be ejected if the ejection conditions are met.
9629 # Defaults to 50%.
9630 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
9631 # enough request volume to detect success rate outliers. If the number of
9632 # backend endpoints is fewer than this setting, outlier detection via success
9633 # rate statistics is not performed for any backend endpoint in the load
9634 # balancing pool. Defaults to 5.
9635 #
9636 # Not supported when the backend service uses Serverless NEG.
9637 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
9638 # (as defined by the interval duration above) to include this backend
9639 # endpoint in success rate based outlier detection. If the volume is lower
9640 # than this setting, outlier detection via success rate statistics is not
9641 # performed for that backend endpoint. Defaults to 100.
9642 #
9643 # Not supported when the backend service uses Serverless NEG.
9644 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
9645 # outlier ejection. The ejection threshold is the difference between the mean
9646 # success rate, and the product of this factor and the standard deviation of
9647 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
9648 # is divided by a thousand to get a double. That is, if the desired factor
9649 # is 1.9, the runtime value should be 1900. Defaults to 1900.
9650 #
9651 # Not supported when the backend service uses Serverless NEG.
9652 },
9653 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
9654 # as part of resource payload.
9655 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
9656 # Tag keys and values have the same definition as resource
9657 # manager tags. The field is allowed for INSERT
9658 # only. The keys/values to set on the resource should be specified in
9659 # either ID { : } or Namespaced format
9660 # { : }.
9661 # For example the following are valid inputs:
9662 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
9663 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
9664 # Note:
9665 # * Invalid combinations of ID &amp; namespaced format is not supported. For
9666 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
9667 &quot;a_key&quot;: &quot;A String&quot;,
9668 },
9669 },
9670 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
9671 # the backend. The default value is 80.
9672 # For internal passthrough Network Load Balancers and external passthrough
9673 # Network Load Balancers, omit port.
9674 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
9675 # communication to the backend VMs in that group. The
9676 # named port must be [defined on each backend instance
9677 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
9678 # This parameter has no meaning if the backends are NEGs. For internal
9679 # passthrough Network Load Balancers and external passthrough Network Load
9680 # Balancers, omit port_name.
9681 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
9682 # with backends.
9683 #
9684 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
9685 # depending on the chosen load balancer or Traffic Director configuration.
9686 # Refer to the documentation for the load balancers or for Traffic Director
9687 # for more information.
9688 #
9689 # Must be set to GRPC when the backend service is referenced by a URL map
9690 # that is bound to target gRPC proxy.
9691 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
9692 # resides. This field is not applicable to global backend services.
9693 # You must specify this field as part of the HTTP request URL. It is
9694 # not settable as a field in the request body.
9695 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
9696 # backend service.
9697 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
9698 # service. This field is applicable to a global backend service with the
9699 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
9700 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
9701 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
9702 # be accepted on backends, and if authenticated, which method/certificate
9703 # will set the request principal.
9704 # request principal.
9705 # The authentication settings for the backend service.
9706 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
9707 # Similar to peers, these will be evaluated in order the first valid one
9708 # will be used to set origin identity. If none of these methods pass, the
9709 # request will be rejected with authentication failed error (401). Leave the
9710 # list empty if origin authentication is not required.
9711 { # [Deprecated] Configuration for the origin authentication method.
9712 # Configuration for the origin authentication method.
9713 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
9714 # JWT configuration for origin authentication.
9715 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
9716 # will be accepted if audiences is empty.
9717 # Examples: bookstore_android.apps.googleusercontent.com,
9718 # bookstore_web.apps.googleusercontent.com
9719 &quot;A String&quot;,
9720 ],
9721 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
9722 # email address.
9723 # Examples: https://securetoken.google.com,
9724 # [email protected]
9725 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
9726 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
9727 # request. If no explicit location is specified, the following default
9728 # locations are tried in order:
9729 #
9730 # 1. The Authorization header using the Bearer schema. See `here
9731 # `_. Example:
9732 #
9733 # Authorization: Bearer .
9734 #
9735 # 2. `access_token` query parameter. See `this
9736 # `_
9737 #
9738 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
9739 # from the locations its issuer specified or from the default locations.
9740 #
9741 # This field is set if JWT is sent in a request header. This field specifies
9742 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
9743 # header format will be x-goog-iap-jwt-assertion: .
9744 { # [Deprecated] This message specifies a header location to extract JWT token.
9745 # This message specifies a header location to extract JWT token.
9746 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
9747 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
9748 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
9749 # with a space at the end.
9750 },
9751 ],
9752 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
9753 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
9754 # JWT format in the query parameter is /path?jwt_token=.
9755 &quot;A String&quot;,
9756 ],
9757 },
9758 },
9759 ],
9760 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
9761 # They will be evaluated in order the first valid one will be used to set
9762 # peer identity. If none of these methods pass, the request will be rejected
9763 # with authentication failed error (401). Leave the list empty if peer
9764 # authentication is not required.
9765 { # [Deprecated] Configuration for the peer authentication method.
9766 # Configuration for the peer authentication method.
9767 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
9768 # Configuration for the mutual Tls mode for peer authentication.
9769 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
9770 # field can be set to one of the following:
9771 # STRICT: Client certificate must be presented, connection is in TLS.
9772 # PERMISSIVE: Client certificate can be omitted, connection can be either
9773 # plaintext or TLS.
9774 },
9775 },
9776 ],
9777 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
9778 # Default value is USE_PEER. If peer (or origin) identity is not available,
9779 # either because peer/origin authentication is not defined, or failed,
9780 # principal will be left unset. In other words, binding rule does not affect
9781 # the decision to accept or reject request. This field can be set to one of
9782 # the following:
9783 # USE_PEER: Principal will be set to the identity from peer authentication.
9784 # USE_ORIGIN: Principal will be set to the identity from origin
9785 # authentication.
9786 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
9787 # identity information.
9788 # The TLS settings for the client or server.
9789 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
9790 # certificate.
9791 # Defines the mechanism to obtain the client or server certificate.
9792 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
9793 # applicable only if tlsCertificateSource is set to USE_PATH.
9794 # The paths to the mounted TLS Certificates and private key.
9795 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9796 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9797 },
9798 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
9799 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
9800 # is applicable only if tlsCertificateSource is set to USE_SDS.
9801 # The configuration to access the SDS server.
9802 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
9803 # gRPC config to access the SDS server.
9804 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
9805 # gRPC call credentials to access the SDS server.
9806 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
9807 # This field can be set to one of the following:
9808 #
9809 # - GCE_VM: The local GCE VM service account credentials are used to access
9810 # the SDS server.
9811 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
9812 # SDS server.
9813 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
9814 # FROM_PLUGIN.
9815 # Custom authenticator credentials.
9816 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
9817 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
9818 # plugin.
9819 },
9820 },
9821 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
9822 # gRPC channel credentials to access the SDS server.
9823 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
9824 # The paths to the mounted TLS Certificates and private key.
9825 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9826 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9827 },
9828 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
9829 # to one of the following:
9830 # CERTIFICATES: Use TLS certificates to access the SDS server.
9831 # GCE_VM: Use local GCE VM credentials to access the SDS server.
9832 },
9833 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
9834 },
9835 },
9836 },
9837 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
9838 # validate the client/server certificate. If omitted, the proxy will not
9839 # validate the server or client certificate.
9840 # certificate to validate the client/server certificate.
9841 # validate the client/server certificate.
9842 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
9843 # client or server certificate.
9844 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
9845 # is applicable only if tlsCertificateSource is set to USE_SDS.
9846 # The configuration to access the SDS server.
9847 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
9848 # gRPC config to access the SDS server.
9849 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
9850 # gRPC call credentials to access the SDS server.
9851 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
9852 # This field can be set to one of the following:
9853 #
9854 # - GCE_VM: The local GCE VM service account credentials are used to access
9855 # the SDS server.
9856 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
9857 # SDS server.
9858 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
9859 # FROM_PLUGIN.
9860 # Custom authenticator credentials.
9861 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
9862 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
9863 # plugin.
9864 },
9865 },
9866 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
9867 # gRPC channel credentials to access the SDS server.
9868 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
9869 # The paths to the mounted TLS Certificates and private key.
9870 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9871 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9872 },
9873 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
9874 # to one of the following:
9875 # CERTIFICATES: Use TLS certificates to access the SDS server.
9876 # GCE_VM: Use local GCE VM credentials to access the SDS server.
9877 },
9878 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
9879 },
9880 },
9881 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
9882 },
9883 },
9884 },
9885 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
9886 # (RBAC) config.
9887 # Authorization config defines the Role Based Access Control (RBAC) config.
9888 # method-level access control for a service.
9889 # control for a service.
9890 &quot;policies&quot;: [ # List of RbacPolicies.
9891 {
9892 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
9893 &quot;permissions&quot;: [ # The list of permissions.
9894 { # [Deprecated] All fields defined in a permission are ANDed.
9895 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
9896 { # Custom constraint that specifies a key and a list of allowed values for
9897 # Istio attributes.
9898 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
9899 &quot;values&quot;: [ # A list of allowed values.
9900 &quot;A String&quot;,
9901 ],
9902 },
9903 ],
9904 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
9905 # applies to. Exact match, prefix match, and suffix match are supported.
9906 &quot;A String&quot;,
9907 ],
9908 &quot;methods&quot;: [ # HTTP method.
9909 &quot;A String&quot;,
9910 ],
9911 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
9912 &quot;A String&quot;,
9913 ],
9914 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
9915 &quot;A String&quot;,
9916 ],
9917 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
9918 &quot;A String&quot;,
9919 ],
9920 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
9921 &quot;A String&quot;,
9922 ],
9923 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
9924 # Exact match, prefix match, and suffix match are supported.
9925 &quot;A String&quot;,
9926 ],
9927 &quot;ports&quot;: [ # Port names or numbers.
9928 &quot;A String&quot;,
9929 ],
9930 },
9931 ],
9932 &quot;principals&quot;: [ # The list of principals.
9933 { # [Deprecated] All fields defined in a principal are ANDed.
9934 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
9935 &quot;groups&quot;: [ # The groups the principal belongs to.
9936 # Exact match, prefix match, and suffix match are supported.
9937 &quot;A String&quot;,
9938 ],
9939 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
9940 &quot;A String&quot;,
9941 ],
9942 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
9943 &quot;A String&quot;,
9944 ],
9945 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
9946 &quot;A String&quot;,
9947 ],
9948 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
9949 &quot;A String&quot;,
9950 ],
9951 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
9952 &quot;A String&quot;,
9953 ],
9954 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
9955 &quot;A String&quot;,
9956 ],
9957 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
9958 # suffix match are supported for values. For example,
9959 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
9960 &quot;a_key&quot;: &quot;A String&quot;,
9961 },
9962 &quot;users&quot;: [ # The user names/IDs or service accounts.
9963 # Exact match, prefix match, and suffix match are supported.
9964 &quot;A String&quot;,
9965 ],
9966 },
9967 ],
9968 },
9969 ],
9970 },
9971 &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
9972 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
9973 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
9974 # private storage buckets that support Signature Version 4 for authentication.
9975 # The service name for generating the authentication header will always default
9976 # to &#x27;s3&#x27;.
9977 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
9978 # creating a backend that uses AWS v4 signature authentication, but will not
9979 # be returned as part of the configuration when queried with a REST API GET
9980 # request.
9981 #
9982 # @InputOnly
9983 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
9984 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
9985 # keep track of different iterations of your access key.
9986 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
9987 # the name of the region your cloud uses to host your origin. For example,
9988 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
9989 },
9990 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
9991 # that describes how clients should authenticate with this service&#x27;s
9992 # backends.
9993 #
9994 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
9995 # to INTERNAL_SELF_MANAGED.
9996 #
9997 # If left blank, communications are not encrypted.
9998 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
9999 # originating from the backend service.
10000 # the backend service.
10001 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
10002 # identity information. This field is only applicable when mode is set to
10003 # MUTUAL.
10004 # The TLS settings for the client or server.
10005 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
10006 # certificate.
10007 # Defines the mechanism to obtain the client or server certificate.
10008 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
10009 # applicable only if tlsCertificateSource is set to USE_PATH.
10010 # The paths to the mounted TLS Certificates and private key.
10011 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
10012 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
10013 },
10014 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
10015 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
10016 # is applicable only if tlsCertificateSource is set to USE_SDS.
10017 # The configuration to access the SDS server.
10018 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
10019 # gRPC config to access the SDS server.
10020 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
10021 # gRPC call credentials to access the SDS server.
10022 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
10023 # This field can be set to one of the following:
10024 #
10025 # - GCE_VM: The local GCE VM service account credentials are used to access
10026 # the SDS server.
10027 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
10028 # SDS server.
10029 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
10030 # FROM_PLUGIN.
10031 # Custom authenticator credentials.
10032 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
10033 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
10034 # plugin.
10035 },
10036 },
10037 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
10038 # gRPC channel credentials to access the SDS server.
10039 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
10040 # The paths to the mounted TLS Certificates and private key.
10041 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
10042 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
10043 },
10044 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
10045 # to one of the following:
10046 # CERTIFICATES: Use TLS certificates to access the SDS server.
10047 # GCE_VM: Use local GCE VM credentials to access the SDS server.
10048 },
10049 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
10050 },
10051 },
10052 },
10053 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
10054 # validate the client/server certificate. If omitted, the proxy will not
10055 # validate the server or client certificate.
10056 # certificate to validate the client/server certificate.
10057 # validate the client/server certificate.
10058 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
10059 # client or server certificate.
10060 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
10061 # is applicable only if tlsCertificateSource is set to USE_SDS.
10062 # The configuration to access the SDS server.
10063 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
10064 # gRPC config to access the SDS server.
10065 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
10066 # gRPC call credentials to access the SDS server.
10067 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
10068 # This field can be set to one of the following:
10069 #
10070 # - GCE_VM: The local GCE VM service account credentials are used to access
10071 # the SDS server.
10072 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
10073 # SDS server.
10074 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
10075 # FROM_PLUGIN.
10076 # Custom authenticator credentials.
10077 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
10078 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
10079 # plugin.
10080 },
10081 },
10082 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
10083 # gRPC channel credentials to access the SDS server.
10084 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
10085 # The paths to the mounted TLS Certificates and private key.
10086 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
10087 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
10088 },
10089 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
10090 # to one of the following:
10091 # CERTIFICATES: Use TLS certificates to access the SDS server.
10092 # GCE_VM: Use local GCE VM credentials to access the SDS server.
10093 },
10094 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
10095 },
10096 },
10097 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
10098 },
10099 },
10100 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
10101 # The value of this field determines how TLS is enforced. This can be set
10102 # to one of the following values: DISABLE: Do not setup a TLS connection to
10103 # the backends.
10104 # SIMPLE: Originate a TLS connection to the backends.
10105 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
10106 # client certificates for authentication.
10107 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
10108 # applicable only when mode is SIMPLE or MUTUAL.
10109 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
10110 # certificate.If specified,
10111 # the proxy will verify that the server certificate&#x27;s subject alt name
10112 # matches one of the specified values. This field is applicable only when
10113 # mode is SIMPLE or MUTUAL.
10114 &quot;A String&quot;,
10115 ],
10116 },
10117 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
10118 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
10119 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
10120 # specified values, the communication continues. Otherwise, it fails. This
10121 # additional check enables the client to verify that the server is authorized
10122 # to run the requested service.
10123 #
10124 # Note that the contents of the server
10125 # certificate&#x27;s subjectAltName field are configured by the
10126 # Public Key Infrastructure which provisions server identities.
10127 #
10128 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
10129 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
10130 # mode).
10131 &quot;A String&quot;,
10132 ],
10133 },
10134 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10135 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
10136 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
10137 #
10138 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
10139 # If set, lists of backends and health checks must be both empty.
10140 &quot;A String&quot;,
10141 ],
10142 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
10143 #
10144 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
10145 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
10146 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
10147 #
10148 # Only NONE and HEADER_FIELD are supported
10149 # when the backend service is referenced by a URL map that is bound to
10150 # target gRPC proxy that has validateForProxyless field set to true.
10151 #
10152 # For more details, see:
10153 # [Session
10154 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
10155 #
10156 # sessionAffinity cannot be specified with haPolicy.
10157 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
10158 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
10159 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
10160 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
10161 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
10162 # as a count of seconds and fractions of seconds at nanosecond
10163 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10164 # or &quot;month&quot;. Range is approximately 10,000 years.
10165 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10166 # Durations less than one second are represented with a 0
10167 # `seconds` field and a positive `nanos` field. Must be from 0
10168 # to 999,999,999 inclusive.
10169 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10170 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10171 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10172 },
10173 },
10174 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
10175 # Currently this is applicable only for Internal TCP/UDP load balancing,
10176 # Internal HTTP(S) load balancing and Traffic Director.
10177 &quot;policy&quot;: &quot;A String&quot;,
10178 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
10179 # each service mesh client.
10180 #
10181 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
10182 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
10183 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
10184 # `INTERNAL_SELF_MANAGED`.
10185 #
10186 # `subset_size` is optional for Internal HTTP(S) load balancing
10187 # and required for Traffic Director.
10188 #
10189 # If you do not provide this value, Cloud Load Balancing will calculate it
10190 # dynamically to optimize the number of proxies/clients visible to each
10191 # backend and vice versa.
10192 #
10193 # Must be greater than 0. If `subset_size` is larger than the number of
10194 # backends/endpoints, then subsetting is disabled.
10195 },
10196 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
10197 # type of load balancer. For more information see,
10198 # Backend service settings.
10199 # The default is 30 seconds.
10200 # The full range of timeout values allowed goes from 1
10201 # through 2,147,483,647 seconds.
10202 #
10203 # This value can be overridden in the PathMatcher configuration of the
10204 # UrlMap that references this backend service.
10205 #
10206 # Not supported when the backend service is referenced by a URL map that is
10207 # bound to target gRPC proxy that has validateForProxyless field set to true.
10208 # Instead, use maxStreamDuration.
10209 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
10210 # when the backend protocol is SSL, HTTPS or HTTP2.
10211 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
10212 # networksecurity.googleapis.com namespace. Can be used in authenticating
10213 # TLS connections to the backend, as specified by the authenticationMode
10214 # field. Can only be specified if authenticationMode is not NONE.
10215 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
10216 #
10217 #
10218 # Use this property to configure the load balancer back-end to use
10219 # certificates and roots of trust provisioned by the Managed Workload
10220 # Identity system.
10221 #
10222 # The `identity` property is the
10223 # fully-specified SPIFFE ID to use in the SVID presented by the Load
10224 # Balancer Workload.
10225 #
10226 # The SPIFFE ID must be a resource starting with the
10227 # `trustDomain` property value, followed by the path to the Managed
10228 # Workload Identity.
10229 #
10230 # Supported SPIFFE ID format:
10231 #
10232 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
10233 #
10234 #
10235 # The Trust Domain within the Managed Identity must refer to a valid
10236 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
10237 # will be inherited from the Workload Identity Pool.
10238 #
10239 # Restrictions:
10240 #
10241 # - If you set the `identity` property, you cannot manually set
10242 # the following fields:
10243 # - tlsSettings.sni
10244 # - tlsSettings.subjectAltNames
10245 # - tlsSettings.authenticationConfig
10246 #
10247 #
10248 # When defining a `identity` for a RegionBackendServices, the
10249 # corresponding Workload Identity Pool must have a ca_pool
10250 # configured in the same region.
10251 #
10252 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
10253 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
10254 # balancer sends this string as the SNI hostname in the TLS connection to
10255 # the backend, and requires that this string match a Subject Alternative
10256 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
10257 # NEG backend, if the SNI is specified here, the load balancer uses it
10258 # regardless of whether the Regional Internet NEG is specified with FQDN or
10259 # IP address and port. When both sni and subjectAltNames[] are specified,
10260 # the load balancer matches the backend certificate&#x27;s SAN only to
10261 # subjectAltNames[].
10262 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
10263 # verifies during a TLS handshake with the backend. When the server
10264 # presents its X.509 certificate to the Load Balancer, the Load Balancer
10265 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
10266 # match one of the subjectAltNames in the list. This field is limited to 5
10267 # entries. When both sni and subjectAltNames[] are specified, the load
10268 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
10269 { # A Subject Alternative Name that the load balancer matches against the SAN
10270 # field in the TLS certificate provided by the backend, specified as either
10271 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
10272 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
10273 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
10274 },
10275 ],
10276 },
10277 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
10278 {
10279 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
10280 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
10281 # and ForwardingRule.
10282 },
10283 ],
10284 }
10285
10286 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
10287 that if you must retry your request, the server will know to ignore the
10288 request if it has already been completed.
10289
10290 For example, consider a situation where you make an initial request and
10291 the request times out. If you make the request again with the same
10292 request ID, the server can check if original operation with the same
10293 request ID was received, and if so, will ignore the second request. This
10294 prevents clients from accidentally creating duplicate commitments.
10295
10296 The request ID must be
10297 a valid UUID with the exception that zero UUID is not supported
10298 (00000000-0000-0000-0000-000000000000).
10299 x__xgafv: string, V1 error format.
10300 Allowed values
10301 1 - v1 error format
10302 2 - v2 error format
10303
10304 Returns:
10305 An object of the form:
10306
10307 { # Represents an Operation resource.
10308 #
10309 # Google Compute Engine has three Operation resources:
10310 #
10311 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
10312 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
10313 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
10314 #
10315 # You can use an operation resource to manage asynchronous API requests.
10316 # For more information, readHandling
10317 # API responses.
10318 #
10319 # Operations can be global, regional or zonal.
10320 #
10321 # - For global operations, use the `globalOperations`
10322 # resource.
10323 # - For regional operations, use the
10324 # `regionOperations` resource.
10325 # - For zonal operations, use
10326 # the `zoneOperations` resource.
10327 #
10328 #
10329 #
10330 # For more information, read
10331 # Global, Regional, and Zonal Resources.
10332 #
10333 # Note that completed Operation resources have a limited
10334 # retention period.
10335 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
10336 # Not present otherwise.
10337 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
10338 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
10339 # set when the operation is created.
10340 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
10341 # text format.
10342 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
10343 # this field will be populated.
10344 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
10345 # operation.
10346 {
10347 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
10348 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
10349 # details. There is a set of defined message types to use for providing
10350 # details.The syntax depends on the error code. For example,
10351 # QuotaExceededInfo will have details when the error code is
10352 # QUOTA_EXCEEDED.
10353 {
10354 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
10355 #
10356 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
10357 # is not enabled:
10358 #
10359 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
10360 # &quot;domain&quot;: &quot;googleapis.com&quot;
10361 # &quot;metadata&quot;: {
10362 # &quot;resource&quot;: &quot;projects/123&quot;,
10363 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
10364 # }
10365 # }
10366 #
10367 # This response indicates that the pubsub.googleapis.com API is not enabled.
10368 #
10369 # Example of an error that is returned when attempting to create a Spanner
10370 # instance in a region that is out of stock:
10371 #
10372 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10373 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10374 # &quot;metadata&quot;: {
10375 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10376 # }
10377 # }
10378 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10379 # is typically the registered service name of the tool or product that
10380 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10381 # generated by some common infrastructure, the error domain must be a
10382 # globally unique value that identifies the infrastructure. For Google API
10383 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10384 &quot;metadatas&quot;: { # Additional structured details about this error.
10385 #
10386 # Keys must match a regular expression of `a-z+` but should
10387 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10388 # length. When identifying the current value of an exceeded limit, the units
10389 # should be contained in the key, not the value. For example, rather than
10390 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10391 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10392 # instances that can be created in a single (batch) request.
10393 &quot;a_key&quot;: &quot;A String&quot;,
10394 },
10395 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10396 # proximate cause of the error. Error reasons are unique within a particular
10397 # domain of errors. This should be at most 63 characters and match a
10398 # regular expression of `A-Z+[A-Z0-9]`, which represents
10399 # UPPER_SNAKE_CASE.
10400 },
10401 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10402 #
10403 # For example, if a quota check failed with an error indicating the calling
10404 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10405 # directly to the right place in the developer console to flip the bit.
10406 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10407 { # Describes a URL link.
10408 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10409 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10410 },
10411 ],
10412 },
10413 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10414 # which can be attached to an RPC error.
10415 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10416 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10417 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10418 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10419 },
10420 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10421 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10422 &quot;a_key&quot;: &quot;A String&quot;,
10423 },
10424 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10425 # type or metric.
10426 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10427 # or metric.
10428 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10429 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10430 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10431 },
10432 },
10433 ],
10434 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10435 # This property is optional.
10436 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10437 },
10438 ],
10439 },
10440 &quot;getVersionOperationMetadata&quot;: {
10441 &quot;inlineSbomInfo&quot;: {
10442 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10443 # appropriate identifiers.
10444 &quot;a_key&quot;: &quot;A String&quot;,
10445 },
10446 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10447 # identifiers.
10448 &quot;a_key&quot;: &quot;A String&quot;,
10449 },
10450 },
10451 },
10452 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10453 # message that was returned, such as `NOT FOUND`.
10454 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10455 # status code that was returned. For example, a `404` means the
10456 # resource was not found.
10457 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10458 # defined by the server.
10459 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10460 # This value is inRFC3339
10461 # text format.
10462 &quot;instancesBulkInsertOperationMetadata&quot;: {
10463 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10464 # Example key: zones/us-central1-a
10465 &quot;a_key&quot;: {
10466 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10467 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10468 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10469 # error.
10470 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10471 # if the flow is rolling forward or rolling back.
10472 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10473 },
10474 },
10475 },
10476 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10477 # Operation resources.
10478 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10479 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10480 # group of operations results from a `bulkInsert` API request.
10481 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10482 # `update`, or `delete`, and so on.
10483 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10484 # There is no requirement that this be linear or support any granularity of
10485 # operations. This should not be used to guess when the operation will be
10486 # complete. This number should monotonically increase as the operation
10487 # progresses.
10488 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10489 # applicable when performing regional operations.
10490 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10491 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
10492 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10493 # this field will contain information on all underlying zonal actions and
10494 # their state.
10495 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10496 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10497 # Example key: zones/us-central1-a
10498 &quot;a_key&quot;: {
10499 &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
10500 # populated.
10501 # different programming environments, including REST APIs and RPC APIs. It is
10502 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10503 # three pieces of data: error code, error message, and error details.
10504 #
10505 # You can find out more about this error model and how to work with it in the
10506 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10507 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10508 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10509 # message types for APIs to use.
10510 {
10511 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10512 },
10513 ],
10514 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10515 # user-facing error message should be localized and sent in the
10516 # google.rpc.Status.details field, or localized by the client.
10517 },
10518 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10519 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10520 },
10521 },
10522 },
10523 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10524 # This value is inRFC3339
10525 # text format.
10526 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10527 # following:
10528 # `PENDING`, `RUNNING`, or `DONE`.
10529 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10530 # operation.
10531 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10532 # of the target resource.
10533 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10534 # operations related to creating a snapshot, this points to the disk
10535 # that the snapshot was created from.
10536 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10537 # `[email protected]` or
10538 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10539 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10540 # operation, this field will be populated.
10541 {
10542 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10543 # Engine returns NO_RESULTS_ON_PAGE if there
10544 # are no results in the response.
10545 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10546 # value format. For example:
10547 #
10548 # &quot;data&quot;: [
10549 # {
10550 # &quot;key&quot;: &quot;scope&quot;,
10551 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10552 # }
10553 {
10554 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10555 # returned. For example, for warnings where there are no results in a list
10556 # request for a particular zone, this key might be scope and
10557 # the key value might be the zone name. Other examples might be a key
10558 # indicating a deprecated resource and a suggested replacement, or a
10559 # warning about invalid network settings (for example, if an instance
10560 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10561 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10562 },
10563 ],
10564 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10565 },
10566 ],
10567 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10568 # applicable when performing per-zone operations.
10569 }</pre>
10570 </div>
10571
10572 <div class="method">
10573 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
10574 <pre>Sets the access control policy on the specified resource.
10575 Replaces any existing policy.
10576
10577 Args:
10578 project: string, Project ID for this request. (required)
10579 region: string, The name of the region for this request. (required)
10580 resource: string, Name or id of the resource for this request. (required)
10581 body: object, The request body.
10582 The object takes the form of:
10583
10584 {
10585 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
10586 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
10587 { # Associates `members`, or principals, with a `role`.
10588 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
10589 #
10590 # If the condition evaluates to `true`, then this binding applies to the
10591 # current request.
10592 #
10593 # If the condition evaluates to `false`, then this binding does not apply to
10594 # the current request. However, a different role binding might grant the same
10595 # role to one or more of the principals in this binding.
10596 #
10597 # To learn which resources support conditions in their IAM policies, see the
10598 # [IAM
10599 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10600 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
10601 # are documented at https://github.com/google/cel-spec.
10602 #
10603 # Example (Comparison):
10604 #
10605 # title: &quot;Summary size limit&quot;
10606 # description: &quot;Determines if a summary is less than 100 chars&quot;
10607 # expression: &quot;document.summary.size() &lt; 100&quot;
10608 #
10609 # Example (Equality):
10610 #
10611 # title: &quot;Requestor is owner&quot;
10612 # description: &quot;Determines if requestor is the document owner&quot;
10613 # expression: &quot;document.owner == request.auth.claims.email&quot;
10614 #
10615 # Example (Logic):
10616 #
10617 # title: &quot;Public documents&quot;
10618 # description: &quot;Determine whether the document should be publicly visible&quot;
10619 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
10620 #
10621 # Example (Data Manipulation):
10622 #
10623 # title: &quot;Notification string&quot;
10624 # description: &quot;Create a notification string with a timestamp.&quot;
10625 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
10626 #
10627 # The exact variables and functions that may be referenced within an expression
10628 # are determined by the service that evaluates it. See the service
10629 # documentation for additional information.
10630 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
10631 # describes the expression, e.g. when hovered over it in a UI.
10632 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
10633 # syntax.
10634 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
10635 # reporting, e.g. a file name and a position in the file.
10636 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
10637 # its purpose. This can be used e.g. in UIs which allow to enter the
10638 # expression.
10639 },
10640 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
10641 # `members` can have the following values:
10642 #
10643 # * `allUsers`: A special identifier that represents anyone who is
10644 # on the internet; with or without a Google account.
10645 #
10646 # * `allAuthenticatedUsers`: A special identifier that represents anyone
10647 # who is authenticated with a Google account or a service account.
10648 # Does not include identities that come from external identity providers
10649 # (IdPs) through identity federation.
10650 #
10651 # * `user:{emailid}`: An email address that represents a specific Google
10652 # account. For example, `[email protected]` .
10653 #
10654 #
10655 # * `serviceAccount:{emailid}`: An email address that represents a Google
10656 # service account. For example,
10657 # `[email protected]`.
10658 #
10659 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
10660 # identifier for a
10661 # [Kubernetes service
10662 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
10663 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
10664 #
10665 # * `group:{emailid}`: An email address that represents a Google group.
10666 # For example, `[email protected]`.
10667 #
10668 #
10669 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
10670 # users of that domain. For example, `google.com` or `example.com`.
10671 #
10672 #
10673 #
10674 #
10675 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10676 # A single identity in a workforce identity pool.
10677 #
10678 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
10679 # All workforce identities in a group.
10680 #
10681 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10682 # All workforce identities with a specific attribute value.
10683 #
10684 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
10685 # All identities in a workforce identity pool.
10686 #
10687 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
10688 # A single identity in a workload identity pool.
10689 #
10690 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
10691 # A workload identity pool group.
10692 #
10693 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10694 # All identities in a workload identity pool with a certain attribute.
10695 #
10696 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
10697 # All identities in a workload identity pool.
10698 #
10699 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
10700 # identifier) representing a user that has been recently deleted. For
10701 # example, `[email protected]?uid=123456789012345678901`. If the user is
10702 # recovered, this value reverts to `user:{emailid}` and the recovered user
10703 # retains the role in the binding.
10704 #
10705 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
10706 # unique identifier) representing a service account that has been recently
10707 # deleted. For example,
10708 # `[email protected]?uid=123456789012345678901`.
10709 # If the service account is undeleted, this value reverts to
10710 # `serviceAccount:{emailid}` and the undeleted service account retains the
10711 # role in the binding.
10712 #
10713 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
10714 # identifier) representing a Google group that has been recently
10715 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
10716 # the group is recovered, this value reverts to `group:{emailid}` and the
10717 # recovered group retains the role in the binding.
10718 #
10719 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10720 # Deleted single identity in a workforce identity pool. For example,
10721 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
10722 &quot;A String&quot;,
10723 ],
10724 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
10725 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
10726 #
10727 # For an overview of the IAM roles and permissions, see the
10728 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
10729 # a list of the available pre-defined roles, see
10730 # [here](https://cloud.google.com/iam/docs/understanding-roles).
10731 },
10732 ],
10733 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
10734 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
10735 &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
10736 # the policy is limited to a few 10s of KB. An empty policy is in general a
10737 # valid policy but certain services (like Projects) might reject them.
10738 # controls for Google Cloud resources.
10739 #
10740 #
10741 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
10742 # `members`, or principals, to a single `role`. Principals can be user
10743 # accounts, service accounts, Google groups, and domains (such as G Suite). A
10744 # `role` is a named list of permissions; each `role` can be an IAM predefined
10745 # role or a user-created custom role.
10746 #
10747 # For some types of Google Cloud resources, a `binding` can also specify a
10748 # `condition`, which is a logical expression that allows access to a resource
10749 # only if the expression evaluates to `true`. A condition can add constraints
10750 # based on attributes of the request, the resource, or both. To learn which
10751 # resources support conditions in their IAM policies, see the
10752 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10753 #
10754 # **JSON example:**
10755 #
10756 # ```
10757 # {
10758 # &quot;bindings&quot;: [
10759 # {
10760 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
10761 # &quot;members&quot;: [
10762 # &quot;user:[email protected]&quot;,
10763 # &quot;group:[email protected]&quot;,
10764 # &quot;domain:google.com&quot;,
10765 # &quot;serviceAccount:[email protected]&quot;
10766 # ]
10767 # },
10768 # {
10769 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
10770 # &quot;members&quot;: [
10771 # &quot;user:[email protected]&quot;
10772 # ],
10773 # &quot;condition&quot;: {
10774 # &quot;title&quot;: &quot;expirable access&quot;,
10775 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
10776 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
10777 # }
10778 # }
10779 # ],
10780 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
10781 # &quot;version&quot;: 3
10782 # }
10783 # ```
10784 #
10785 # **YAML example:**
10786 #
10787 # ```
10788 # bindings:
10789 # - members:
10790 # - user:[email protected]
10791 # - group:[email protected]
10792 # - domain:google.com
10793 # - serviceAccount:[email protected]
10794 # role: roles/resourcemanager.organizationAdmin
10795 # - members:
10796 # - user:[email protected]
10797 # role: roles/resourcemanager.organizationViewer
10798 # condition:
10799 # title: expirable access
10800 # description: Does not grant access after Sep 2020
10801 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
10802 # etag: BwWWja0YfJA=
10803 # version: 3
10804 # ```
10805 #
10806 # For a description of IAM and its features, see the
10807 # [IAM documentation](https://cloud.google.com/iam/docs/).
10808 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
10809 { # Specifies the audit configuration for a service.
10810 # The configuration determines which permission types are logged, and what
10811 # identities, if any, are exempted from logging.
10812 # An AuditConfig must have one or more AuditLogConfigs.
10813 #
10814 # If there are AuditConfigs for both `allServices` and a specific service,
10815 # the union of the two AuditConfigs is used for that service: the log_types
10816 # specified in each AuditConfig are enabled, and the exempted_members in each
10817 # AuditLogConfig are exempted.
10818 #
10819 # Example Policy with multiple AuditConfigs:
10820 #
10821 # {
10822 # &quot;audit_configs&quot;: [
10823 # {
10824 # &quot;service&quot;: &quot;allServices&quot;,
10825 # &quot;audit_log_configs&quot;: [
10826 # {
10827 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
10828 # &quot;exempted_members&quot;: [
10829 # &quot;user:[email protected]&quot;
10830 # ]
10831 # },
10832 # {
10833 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
10834 # },
10835 # {
10836 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
10837 # }
10838 # ]
10839 # },
10840 # {
10841 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
10842 # &quot;audit_log_configs&quot;: [
10843 # {
10844 # &quot;log_type&quot;: &quot;DATA_READ&quot;
10845 # },
10846 # {
10847 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
10848 # &quot;exempted_members&quot;: [
10849 # &quot;user:[email protected]&quot;
10850 # ]
10851 # }
10852 # ]
10853 # }
10854 # ]
10855 # }
10856 #
10857 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
10858 # logging. It also exempts `[email protected]` from DATA_READ logging, and
10859 # `[email protected]` from DATA_WRITE logging.
10860 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
10861 { # Provides the configuration for logging a type of permissions.
10862 # Example:
10863 #
10864 # {
10865 # &quot;audit_log_configs&quot;: [
10866 # {
10867 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
10868 # &quot;exempted_members&quot;: [
10869 # &quot;user:[email protected]&quot;
10870 # ]
10871 # },
10872 # {
10873 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
10874 # }
10875 # ]
10876 # }
10877 #
10878 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
10879 # [email protected] from DATA_READ logging.
10880 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
10881 # permission.
10882 # Follows the same format of Binding.members.
10883 &quot;A String&quot;,
10884 ],
10885 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
10886 },
10887 ],
10888 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
10889 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
10890 # `allServices` is a special value that covers all services.
10891 },
10892 ],
10893 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
10894 # may specify a `condition` that determines how and when the `bindings` are
10895 # applied. Each of the `bindings` must contain at least one principal.
10896 #
10897 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
10898 # of these principals can be Google groups. Each occurrence of a principal
10899 # counts towards these limits. For example, if the `bindings` grant 50
10900 # different roles to `user:[email protected]`, and not to any other
10901 # principal, then you can add another 1,450 principals to the `bindings` in
10902 # the `Policy`.
10903 { # Associates `members`, or principals, with a `role`.
10904 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
10905 #
10906 # If the condition evaluates to `true`, then this binding applies to the
10907 # current request.
10908 #
10909 # If the condition evaluates to `false`, then this binding does not apply to
10910 # the current request. However, a different role binding might grant the same
10911 # role to one or more of the principals in this binding.
10912 #
10913 # To learn which resources support conditions in their IAM policies, see the
10914 # [IAM
10915 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10916 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
10917 # are documented at https://github.com/google/cel-spec.
10918 #
10919 # Example (Comparison):
10920 #
10921 # title: &quot;Summary size limit&quot;
10922 # description: &quot;Determines if a summary is less than 100 chars&quot;
10923 # expression: &quot;document.summary.size() &lt; 100&quot;
10924 #
10925 # Example (Equality):
10926 #
10927 # title: &quot;Requestor is owner&quot;
10928 # description: &quot;Determines if requestor is the document owner&quot;
10929 # expression: &quot;document.owner == request.auth.claims.email&quot;
10930 #
10931 # Example (Logic):
10932 #
10933 # title: &quot;Public documents&quot;
10934 # description: &quot;Determine whether the document should be publicly visible&quot;
10935 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
10936 #
10937 # Example (Data Manipulation):
10938 #
10939 # title: &quot;Notification string&quot;
10940 # description: &quot;Create a notification string with a timestamp.&quot;
10941 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
10942 #
10943 # The exact variables and functions that may be referenced within an expression
10944 # are determined by the service that evaluates it. See the service
10945 # documentation for additional information.
10946 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
10947 # describes the expression, e.g. when hovered over it in a UI.
10948 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
10949 # syntax.
10950 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
10951 # reporting, e.g. a file name and a position in the file.
10952 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
10953 # its purpose. This can be used e.g. in UIs which allow to enter the
10954 # expression.
10955 },
10956 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
10957 # `members` can have the following values:
10958 #
10959 # * `allUsers`: A special identifier that represents anyone who is
10960 # on the internet; with or without a Google account.
10961 #
10962 # * `allAuthenticatedUsers`: A special identifier that represents anyone
10963 # who is authenticated with a Google account or a service account.
10964 # Does not include identities that come from external identity providers
10965 # (IdPs) through identity federation.
10966 #
10967 # * `user:{emailid}`: An email address that represents a specific Google
10968 # account. For example, `[email protected]` .
10969 #
10970 #
10971 # * `serviceAccount:{emailid}`: An email address that represents a Google
10972 # service account. For example,
10973 # `[email protected]`.
10974 #
10975 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
10976 # identifier for a
10977 # [Kubernetes service
10978 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
10979 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
10980 #
10981 # * `group:{emailid}`: An email address that represents a Google group.
10982 # For example, `[email protected]`.
10983 #
10984 #
10985 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
10986 # users of that domain. For example, `google.com` or `example.com`.
10987 #
10988 #
10989 #
10990 #
10991 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10992 # A single identity in a workforce identity pool.
10993 #
10994 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
10995 # All workforce identities in a group.
10996 #
10997 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10998 # All workforce identities with a specific attribute value.
10999 #
11000 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
11001 # All identities in a workforce identity pool.
11002 #
11003 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
11004 # A single identity in a workload identity pool.
11005 #
11006 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
11007 # A workload identity pool group.
11008 #
11009 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11010 # All identities in a workload identity pool with a certain attribute.
11011 #
11012 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
11013 # All identities in a workload identity pool.
11014 #
11015 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
11016 # identifier) representing a user that has been recently deleted. For
11017 # example, `[email protected]?uid=123456789012345678901`. If the user is
11018 # recovered, this value reverts to `user:{emailid}` and the recovered user
11019 # retains the role in the binding.
11020 #
11021 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
11022 # unique identifier) representing a service account that has been recently
11023 # deleted. For example,
11024 # `[email protected]?uid=123456789012345678901`.
11025 # If the service account is undeleted, this value reverts to
11026 # `serviceAccount:{emailid}` and the undeleted service account retains the
11027 # role in the binding.
11028 #
11029 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
11030 # identifier) representing a Google group that has been recently
11031 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
11032 # the group is recovered, this value reverts to `group:{emailid}` and the
11033 # recovered group retains the role in the binding.
11034 #
11035 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11036 # Deleted single identity in a workforce identity pool. For example,
11037 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
11038 &quot;A String&quot;,
11039 ],
11040 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
11041 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
11042 #
11043 # For an overview of the IAM roles and permissions, see the
11044 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
11045 # a list of the available pre-defined roles, see
11046 # [here](https://cloud.google.com/iam/docs/understanding-roles).
11047 },
11048 ],
11049 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
11050 # prevent simultaneous updates of a policy from overwriting each other.
11051 # It is strongly suggested that systems make use of the `etag` in the
11052 # read-modify-write cycle to perform policy updates in order to avoid race
11053 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
11054 # systems are expected to put that etag in the request to `setIamPolicy` to
11055 # ensure that their change will be applied to the same version of the policy.
11056 #
11057 # **Important:** If you use IAM Conditions, you must include the `etag` field
11058 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11059 # you to overwrite a version `3` policy with a version `1` policy, and all of
11060 # the conditions in the version `3` policy are lost.
11061 &quot;version&quot;: 42, # Specifies the format of the policy.
11062 #
11063 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
11064 # are rejected.
11065 #
11066 # Any operation that affects conditional role bindings must specify version
11067 # `3`. This requirement applies to the following operations:
11068 #
11069 # * Getting a policy that includes a conditional role binding
11070 # * Adding a conditional role binding to a policy
11071 # * Changing a conditional role binding in a policy
11072 # * Removing any role binding, with or without a condition, from a policy
11073 # that includes conditions
11074 #
11075 # **Important:** If you use IAM Conditions, you must include the `etag` field
11076 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11077 # you to overwrite a version `3` policy with a version `1` policy, and all of
11078 # the conditions in the version `3` policy are lost.
11079 #
11080 # If a policy does not include any conditions, operations on that policy may
11081 # specify any valid version or leave the field unset.
11082 #
11083 # To learn which resources support conditions in their IAM policies, see the
11084 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11085 },
11086 }
11087
11088 x__xgafv: string, V1 error format.
11089 Allowed values
11090 1 - v1 error format
11091 2 - v2 error format
11092
11093 Returns:
11094 An object of the form:
11095
11096 { # An Identity and Access Management (IAM) policy, which specifies access
11097 # controls for Google Cloud resources.
11098 #
11099 #
11100 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
11101 # `members`, or principals, to a single `role`. Principals can be user
11102 # accounts, service accounts, Google groups, and domains (such as G Suite). A
11103 # `role` is a named list of permissions; each `role` can be an IAM predefined
11104 # role or a user-created custom role.
11105 #
11106 # For some types of Google Cloud resources, a `binding` can also specify a
11107 # `condition`, which is a logical expression that allows access to a resource
11108 # only if the expression evaluates to `true`. A condition can add constraints
11109 # based on attributes of the request, the resource, or both. To learn which
11110 # resources support conditions in their IAM policies, see the
11111 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11112 #
11113 # **JSON example:**
11114 #
11115 # ```
11116 # {
11117 # &quot;bindings&quot;: [
11118 # {
11119 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
11120 # &quot;members&quot;: [
11121 # &quot;user:[email protected]&quot;,
11122 # &quot;group:[email protected]&quot;,
11123 # &quot;domain:google.com&quot;,
11124 # &quot;serviceAccount:[email protected]&quot;
11125 # ]
11126 # },
11127 # {
11128 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
11129 # &quot;members&quot;: [
11130 # &quot;user:[email protected]&quot;
11131 # ],
11132 # &quot;condition&quot;: {
11133 # &quot;title&quot;: &quot;expirable access&quot;,
11134 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
11135 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
11136 # }
11137 # }
11138 # ],
11139 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
11140 # &quot;version&quot;: 3
11141 # }
11142 # ```
11143 #
11144 # **YAML example:**
11145 #
11146 # ```
11147 # bindings:
11148 # - members:
11149 # - user:[email protected]
11150 # - group:[email protected]
11151 # - domain:google.com
11152 # - serviceAccount:[email protected]
11153 # role: roles/resourcemanager.organizationAdmin
11154 # - members:
11155 # - user:[email protected]
11156 # role: roles/resourcemanager.organizationViewer
11157 # condition:
11158 # title: expirable access
11159 # description: Does not grant access after Sep 2020
11160 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
11161 # etag: BwWWja0YfJA=
11162 # version: 3
11163 # ```
11164 #
11165 # For a description of IAM and its features, see the
11166 # [IAM documentation](https://cloud.google.com/iam/docs/).
11167 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
11168 { # Specifies the audit configuration for a service.
11169 # The configuration determines which permission types are logged, and what
11170 # identities, if any, are exempted from logging.
11171 # An AuditConfig must have one or more AuditLogConfigs.
11172 #
11173 # If there are AuditConfigs for both `allServices` and a specific service,
11174 # the union of the two AuditConfigs is used for that service: the log_types
11175 # specified in each AuditConfig are enabled, and the exempted_members in each
11176 # AuditLogConfig are exempted.
11177 #
11178 # Example Policy with multiple AuditConfigs:
11179 #
11180 # {
11181 # &quot;audit_configs&quot;: [
11182 # {
11183 # &quot;service&quot;: &quot;allServices&quot;,
11184 # &quot;audit_log_configs&quot;: [
11185 # {
11186 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
11187 # &quot;exempted_members&quot;: [
11188 # &quot;user:[email protected]&quot;
11189 # ]
11190 # },
11191 # {
11192 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
11193 # },
11194 # {
11195 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
11196 # }
11197 # ]
11198 # },
11199 # {
11200 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
11201 # &quot;audit_log_configs&quot;: [
11202 # {
11203 # &quot;log_type&quot;: &quot;DATA_READ&quot;
11204 # },
11205 # {
11206 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
11207 # &quot;exempted_members&quot;: [
11208 # &quot;user:[email protected]&quot;
11209 # ]
11210 # }
11211 # ]
11212 # }
11213 # ]
11214 # }
11215 #
11216 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
11217 # logging. It also exempts `[email protected]` from DATA_READ logging, and
11218 # `[email protected]` from DATA_WRITE logging.
11219 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
11220 { # Provides the configuration for logging a type of permissions.
11221 # Example:
11222 #
11223 # {
11224 # &quot;audit_log_configs&quot;: [
11225 # {
11226 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
11227 # &quot;exempted_members&quot;: [
11228 # &quot;user:[email protected]&quot;
11229 # ]
11230 # },
11231 # {
11232 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
11233 # }
11234 # ]
11235 # }
11236 #
11237 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
11238 # [email protected] from DATA_READ logging.
11239 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
11240 # permission.
11241 # Follows the same format of Binding.members.
11242 &quot;A String&quot;,
11243 ],
11244 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
11245 },
11246 ],
11247 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
11248 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
11249 # `allServices` is a special value that covers all services.
11250 },
11251 ],
11252 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
11253 # may specify a `condition` that determines how and when the `bindings` are
11254 # applied. Each of the `bindings` must contain at least one principal.
11255 #
11256 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
11257 # of these principals can be Google groups. Each occurrence of a principal
11258 # counts towards these limits. For example, if the `bindings` grant 50
11259 # different roles to `user:[email protected]`, and not to any other
11260 # principal, then you can add another 1,450 principals to the `bindings` in
11261 # the `Policy`.
11262 { # Associates `members`, or principals, with a `role`.
11263 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
11264 #
11265 # If the condition evaluates to `true`, then this binding applies to the
11266 # current request.
11267 #
11268 # If the condition evaluates to `false`, then this binding does not apply to
11269 # the current request. However, a different role binding might grant the same
11270 # role to one or more of the principals in this binding.
11271 #
11272 # To learn which resources support conditions in their IAM policies, see the
11273 # [IAM
11274 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11275 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
11276 # are documented at https://github.com/google/cel-spec.
11277 #
11278 # Example (Comparison):
11279 #
11280 # title: &quot;Summary size limit&quot;
11281 # description: &quot;Determines if a summary is less than 100 chars&quot;
11282 # expression: &quot;document.summary.size() &lt; 100&quot;
11283 #
11284 # Example (Equality):
11285 #
11286 # title: &quot;Requestor is owner&quot;
11287 # description: &quot;Determines if requestor is the document owner&quot;
11288 # expression: &quot;document.owner == request.auth.claims.email&quot;
11289 #
11290 # Example (Logic):
11291 #
11292 # title: &quot;Public documents&quot;
11293 # description: &quot;Determine whether the document should be publicly visible&quot;
11294 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
11295 #
11296 # Example (Data Manipulation):
11297 #
11298 # title: &quot;Notification string&quot;
11299 # description: &quot;Create a notification string with a timestamp.&quot;
11300 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
11301 #
11302 # The exact variables and functions that may be referenced within an expression
11303 # are determined by the service that evaluates it. See the service
11304 # documentation for additional information.
11305 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
11306 # describes the expression, e.g. when hovered over it in a UI.
11307 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
11308 # syntax.
11309 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
11310 # reporting, e.g. a file name and a position in the file.
11311 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
11312 # its purpose. This can be used e.g. in UIs which allow to enter the
11313 # expression.
11314 },
11315 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
11316 # `members` can have the following values:
11317 #
11318 # * `allUsers`: A special identifier that represents anyone who is
11319 # on the internet; with or without a Google account.
11320 #
11321 # * `allAuthenticatedUsers`: A special identifier that represents anyone
11322 # who is authenticated with a Google account or a service account.
11323 # Does not include identities that come from external identity providers
11324 # (IdPs) through identity federation.
11325 #
11326 # * `user:{emailid}`: An email address that represents a specific Google
11327 # account. For example, `[email protected]` .
11328 #
11329 #
11330 # * `serviceAccount:{emailid}`: An email address that represents a Google
11331 # service account. For example,
11332 # `[email protected]`.
11333 #
11334 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
11335 # identifier for a
11336 # [Kubernetes service
11337 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
11338 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
11339 #
11340 # * `group:{emailid}`: An email address that represents a Google group.
11341 # For example, `[email protected]`.
11342 #
11343 #
11344 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
11345 # users of that domain. For example, `google.com` or `example.com`.
11346 #
11347 #
11348 #
11349 #
11350 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11351 # A single identity in a workforce identity pool.
11352 #
11353 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
11354 # All workforce identities in a group.
11355 #
11356 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11357 # All workforce identities with a specific attribute value.
11358 #
11359 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
11360 # All identities in a workforce identity pool.
11361 #
11362 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
11363 # A single identity in a workload identity pool.
11364 #
11365 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
11366 # A workload identity pool group.
11367 #
11368 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11369 # All identities in a workload identity pool with a certain attribute.
11370 #
11371 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
11372 # All identities in a workload identity pool.
11373 #
11374 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
11375 # identifier) representing a user that has been recently deleted. For
11376 # example, `[email protected]?uid=123456789012345678901`. If the user is
11377 # recovered, this value reverts to `user:{emailid}` and the recovered user
11378 # retains the role in the binding.
11379 #
11380 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
11381 # unique identifier) representing a service account that has been recently
11382 # deleted. For example,
11383 # `[email protected]?uid=123456789012345678901`.
11384 # If the service account is undeleted, this value reverts to
11385 # `serviceAccount:{emailid}` and the undeleted service account retains the
11386 # role in the binding.
11387 #
11388 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
11389 # identifier) representing a Google group that has been recently
11390 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
11391 # the group is recovered, this value reverts to `group:{emailid}` and the
11392 # recovered group retains the role in the binding.
11393 #
11394 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11395 # Deleted single identity in a workforce identity pool. For example,
11396 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
11397 &quot;A String&quot;,
11398 ],
11399 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
11400 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
11401 #
11402 # For an overview of the IAM roles and permissions, see the
11403 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
11404 # a list of the available pre-defined roles, see
11405 # [here](https://cloud.google.com/iam/docs/understanding-roles).
11406 },
11407 ],
11408 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
11409 # prevent simultaneous updates of a policy from overwriting each other.
11410 # It is strongly suggested that systems make use of the `etag` in the
11411 # read-modify-write cycle to perform policy updates in order to avoid race
11412 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
11413 # systems are expected to put that etag in the request to `setIamPolicy` to
11414 # ensure that their change will be applied to the same version of the policy.
11415 #
11416 # **Important:** If you use IAM Conditions, you must include the `etag` field
11417 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11418 # you to overwrite a version `3` policy with a version `1` policy, and all of
11419 # the conditions in the version `3` policy are lost.
11420 &quot;version&quot;: 42, # Specifies the format of the policy.
11421 #
11422 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
11423 # are rejected.
11424 #
11425 # Any operation that affects conditional role bindings must specify version
11426 # `3`. This requirement applies to the following operations:
11427 #
11428 # * Getting a policy that includes a conditional role binding
11429 # * Adding a conditional role binding to a policy
11430 # * Changing a conditional role binding in a policy
11431 # * Removing any role binding, with or without a condition, from a policy
11432 # that includes conditions
11433 #
11434 # **Important:** If you use IAM Conditions, you must include the `etag` field
11435 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11436 # you to overwrite a version `3` policy with a version `1` policy, and all of
11437 # the conditions in the version `3` policy are lost.
11438 #
11439 # If a policy does not include any conditions, operations on that policy may
11440 # specify any valid version or leave the field unset.
11441 #
11442 # To learn which resources support conditions in their IAM policies, see the
11443 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11444 }</pre>
11445 </div>
11446
11447 <div class="method">
11448 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
11449 <pre>Sets the Google Cloud Armor security policy for the specified backend
11450 service. For more information, seeGoogle
11451 Cloud Armor Overview
11452
11453 Args:
11454 project: string, Project ID for this request. (required)
11455 region: string, Name of the region scoping this request. (required)
11456 backendService: string, Name of the BackendService resource to which the security policy should be
11457 set. The name should conform to RFC1035. (required)
11458 body: object, The request body.
11459 The object takes the form of:
11460
11461 {
11462 &quot;securityPolicy&quot;: &quot;A String&quot;,
11463 }
11464
11465 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11466 that if you must retry your request, the server will know to ignore the
11467 request if it has already been completed.
11468
11469 For example, consider a situation where you make an initial request and
11470 the request times out. If you make the request again with the same
11471 request ID, the server can check if original operation with the same
11472 request ID was received, and if so, will ignore the second request. This
11473 prevents clients from accidentally creating duplicate commitments.
11474
11475 The request ID must be
11476 a valid UUID with the exception that zero UUID is not supported
11477 (00000000-0000-0000-0000-000000000000).
11478 x__xgafv: string, V1 error format.
11479 Allowed values
11480 1 - v1 error format
11481 2 - v2 error format
11482
11483 Returns:
11484 An object of the form:
11485
11486 { # Represents an Operation resource.
11487 #
11488 # Google Compute Engine has three Operation resources:
11489 #
11490 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
11491 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
11492 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
11493 #
11494 # You can use an operation resource to manage asynchronous API requests.
11495 # For more information, readHandling
11496 # API responses.
11497 #
11498 # Operations can be global, regional or zonal.
11499 #
11500 # - For global operations, use the `globalOperations`
11501 # resource.
11502 # - For regional operations, use the
11503 # `regionOperations` resource.
11504 # - For zonal operations, use
11505 # the `zoneOperations` resource.
11506 #
11507 #
11508 #
11509 # For more information, read
11510 # Global, Regional, and Zonal Resources.
11511 #
11512 # Note that completed Operation resources have a limited
11513 # retention period.
11514 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11515 # Not present otherwise.
11516 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11517 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11518 # set when the operation is created.
11519 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11520 # text format.
11521 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11522 # this field will be populated.
11523 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11524 # operation.
11525 {
11526 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11527 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11528 # details. There is a set of defined message types to use for providing
11529 # details.The syntax depends on the error code. For example,
11530 # QuotaExceededInfo will have details when the error code is
11531 # QUOTA_EXCEEDED.
11532 {
11533 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11534 #
11535 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11536 # is not enabled:
11537 #
11538 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11539 # &quot;domain&quot;: &quot;googleapis.com&quot;
11540 # &quot;metadata&quot;: {
11541 # &quot;resource&quot;: &quot;projects/123&quot;,
11542 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11543 # }
11544 # }
11545 #
11546 # This response indicates that the pubsub.googleapis.com API is not enabled.
11547 #
11548 # Example of an error that is returned when attempting to create a Spanner
11549 # instance in a region that is out of stock:
11550 #
11551 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11552 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11553 # &quot;metadata&quot;: {
11554 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11555 # }
11556 # }
11557 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11558 # is typically the registered service name of the tool or product that
11559 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11560 # generated by some common infrastructure, the error domain must be a
11561 # globally unique value that identifies the infrastructure. For Google API
11562 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11563 &quot;metadatas&quot;: { # Additional structured details about this error.
11564 #
11565 # Keys must match a regular expression of `a-z+` but should
11566 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11567 # length. When identifying the current value of an exceeded limit, the units
11568 # should be contained in the key, not the value. For example, rather than
11569 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11570 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11571 # instances that can be created in a single (batch) request.
11572 &quot;a_key&quot;: &quot;A String&quot;,
11573 },
11574 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11575 # proximate cause of the error. Error reasons are unique within a particular
11576 # domain of errors. This should be at most 63 characters and match a
11577 # regular expression of `A-Z+[A-Z0-9]`, which represents
11578 # UPPER_SNAKE_CASE.
11579 },
11580 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11581 #
11582 # For example, if a quota check failed with an error indicating the calling
11583 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11584 # directly to the right place in the developer console to flip the bit.
11585 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11586 { # Describes a URL link.
11587 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11588 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11589 },
11590 ],
11591 },
11592 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11593 # which can be attached to an RPC error.
11594 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11595 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11596 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11597 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11598 },
11599 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11600 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11601 &quot;a_key&quot;: &quot;A String&quot;,
11602 },
11603 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11604 # type or metric.
11605 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11606 # or metric.
11607 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11608 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11609 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11610 },
11611 },
11612 ],
11613 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11614 # This property is optional.
11615 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11616 },
11617 ],
11618 },
11619 &quot;getVersionOperationMetadata&quot;: {
11620 &quot;inlineSbomInfo&quot;: {
11621 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11622 # appropriate identifiers.
11623 &quot;a_key&quot;: &quot;A String&quot;,
11624 },
11625 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11626 # identifiers.
11627 &quot;a_key&quot;: &quot;A String&quot;,
11628 },
11629 },
11630 },
11631 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11632 # message that was returned, such as `NOT FOUND`.
11633 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11634 # status code that was returned. For example, a `404` means the
11635 # resource was not found.
11636 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11637 # defined by the server.
11638 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11639 # This value is inRFC3339
11640 # text format.
11641 &quot;instancesBulkInsertOperationMetadata&quot;: {
11642 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11643 # Example key: zones/us-central1-a
11644 &quot;a_key&quot;: {
11645 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11646 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11647 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11648 # error.
11649 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11650 # if the flow is rolling forward or rolling back.
11651 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11652 },
11653 },
11654 },
11655 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11656 # Operation resources.
11657 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11658 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11659 # group of operations results from a `bulkInsert` API request.
11660 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11661 # `update`, or `delete`, and so on.
11662 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11663 # There is no requirement that this be linear or support any granularity of
11664 # operations. This should not be used to guess when the operation will be
11665 # complete. This number should monotonically increase as the operation
11666 # progresses.
11667 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11668 # applicable when performing regional operations.
11669 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11670 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
11671 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11672 # this field will contain information on all underlying zonal actions and
11673 # their state.
11674 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11675 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11676 # Example key: zones/us-central1-a
11677 &quot;a_key&quot;: {
11678 &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
11679 # populated.
11680 # different programming environments, including REST APIs and RPC APIs. It is
11681 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11682 # three pieces of data: error code, error message, and error details.
11683 #
11684 # You can find out more about this error model and how to work with it in the
11685 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11686 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11687 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11688 # message types for APIs to use.
11689 {
11690 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11691 },
11692 ],
11693 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11694 # user-facing error message should be localized and sent in the
11695 # google.rpc.Status.details field, or localized by the client.
11696 },
11697 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11698 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11699 },
11700 },
11701 },
11702 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11703 # This value is inRFC3339
11704 # text format.
11705 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11706 # following:
11707 # `PENDING`, `RUNNING`, or `DONE`.
11708 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11709 # operation.
11710 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11711 # of the target resource.
11712 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11713 # operations related to creating a snapshot, this points to the disk
11714 # that the snapshot was created from.
11715 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11716 # `[email protected]` or
11717 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11718 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11719 # operation, this field will be populated.
11720 {
11721 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11722 # Engine returns NO_RESULTS_ON_PAGE if there
11723 # are no results in the response.
11724 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11725 # value format. For example:
11726 #
11727 # &quot;data&quot;: [
11728 # {
11729 # &quot;key&quot;: &quot;scope&quot;,
11730 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11731 # }
11732 {
11733 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11734 # returned. For example, for warnings where there are no results in a list
11735 # request for a particular zone, this key might be scope and
11736 # the key value might be the zone name. Other examples might be a key
11737 # indicating a deprecated resource and a suggested replacement, or a
11738 # warning about invalid network settings (for example, if an instance
11739 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11740 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11741 },
11742 ],
11743 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11744 },
11745 ],
11746 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11747 # applicable when performing per-zone operations.
11748 }</pre>
11749 </div>
11750
11751 <div class="method">
11752 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
11753 <pre>Returns permissions that a caller has on the specified resource.
11754
11755 Args:
11756 project: string, Project ID for this request. (required)
11757 region: string, The name of the region for this request. (required)
11758 resource: string, Name or id of the resource for this request. (required)
11759 body: object, The request body.
11760 The object takes the form of:
11761
11762 {
11763 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
11764 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
11765 &quot;A String&quot;,
11766 ],
11767 }
11768
11769 x__xgafv: string, V1 error format.
11770 Allowed values
11771 1 - v1 error format
11772 2 - v2 error format
11773
11774 Returns:
11775 An object of the form:
11776
11777 {
11778 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
11779 # allowed.
11780 &quot;A String&quot;,
11781 ],
11782 }</pre>
11783 </div>
11784
11785 <div class="method">
11786 <code class="details" id="update">update(project, region, backendService, body=None, requestId=None, x__xgafv=None)</code>
11787 <pre>Updates the specified regional BackendService resource with the data
11788 included in the request. For more information,
11789 see
11790 Backend services overview.
11791
11792 Args:
11793 project: string, Project ID for this request. (required)
11794 region: string, Name of the region scoping this request. (required)
11795 backendService: string, Name of the BackendService resource to update. (required)
11796 body: object, The request body.
11797 The object takes the form of:
11798
11799 { # Represents a Backend Service resource.
11800 #
11801 # A backend service defines how Google Cloud load balancers distribute traffic.
11802 # The backend service configuration contains a set of values, such as the
11803 # protocol used to connect to backends, various distribution and session
11804 # settings, health checks, and timeouts. These settings provide fine-grained
11805 # control over how your load balancer behaves. Most of the settings have
11806 # default values that allow for easy configuration if you need to get started
11807 # quickly.
11808 #
11809 # Backend services in Google Compute Engine can be either regionally or
11810 # globally scoped.
11811 #
11812 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
11813 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
11814 #
11815 # For more information, seeBackend
11816 # Services.
11817 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
11818 # Load Balancers and Traffic Director and requires
11819 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
11820 #
11821 # If set to 0, the cookie is non-persistent and lasts only until
11822 # the end of the browser session (or equivalent). The maximum allowed value
11823 # is two weeks (1,209,600).
11824 #
11825 # Not supported when the backend service is referenced by a URL map that is
11826 # bound to target gRPC proxy that has validateForProxyless field set to true.
11827 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
11828 # load balancing scheme set to INTERNAL_SELF_MANAGED.
11829 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
11830 { # Message containing information of one individual backend.
11831 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
11832 # handle additional traffic or is fully loaded. For usage guidelines, see
11833 # Connection balancing mode.
11834 #
11835 # Backends must use compatible balancing modes. For more information, see
11836 # Supported balancing modes and target capacity settings and
11837 # Restrictions and guidance for instance groups.
11838 #
11839 # Note: Currently, if you use the API to configure incompatible balancing
11840 # modes, the configuration might be accepted even though it has no impact
11841 # and is ignored. Specifically, Backend.maxUtilization is ignored when
11842 # Backend.balancingMode is RATE. In the future, this incompatible combination
11843 # will be rejected.
11844 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
11845 # mode.
11846 # The default value is 1, which means the group serves up to
11847 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
11848 # completely drained, offering 0% of its available capacity. The valid ranges
11849 # are 0.0 and [0.1,1.0].
11850 # You cannot configure a setting larger than 0 and smaller than0.1.
11851 # You cannot configure a setting of 0 when there is only one
11852 # backend attached to the backend service.
11853 #
11854 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
11855 # internet NEGs, regional serverless NEGs, and PSC NEGs.
11856 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
11857 # BalancingMode.
11858 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
11859 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
11860 # Monitoring, but is not used for load balancing.
11861 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
11862 # balancing mode. The valid range is [0.0, 1.0].
11863 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
11864 # long and match the regular expression
11865 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
11866 # first character must be a lowercase letter, and all following
11867 # characters must be a dash, period, underscore, lowercase letter, or
11868 # digit, except the last character, which cannot be a dash, period, or
11869 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
11870 # field can only be used for a global or regional backend service with the
11871 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
11872 },
11873 ],
11874 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
11875 # create the resource.
11876 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
11877 # failover backend can be configured for a given BackendService.
11878 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
11879 # group or network endpoint
11880 # group (NEG) resource. To determine what types of backends a load
11881 # balancer supports, see the [Backend services
11882 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
11883 #
11884 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
11885 # or NEG. Partial URLs are not supported.
11886 #
11887 # If haPolicy is specified, backends must refer to NEG resources of type
11888 # GCE_VM_IP.
11889 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
11890 # guidelines, seeConnection
11891 # balancing mode and Utilization
11892 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
11893 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
11894 # guidelines, seeConnection
11895 # balancing mode and Utilization
11896 # balancing mode.
11897 #
11898 # Not available if the backend&#x27;s balancingMode isRATE.
11899 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
11900 # For usage guidelines, seeConnection
11901 # balancing mode and Utilization
11902 # balancing mode.
11903 #
11904 # Not available if the backend&#x27;s balancingMode isRATE.
11905 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
11906 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
11907 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
11908 # Not available if backend&#x27;s balancingMode is RATE
11909 # or CONNECTION.
11910 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
11911 # Not available if backend&#x27;s balancingMode is RATE
11912 # or CONNECTION.
11913 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
11914 # usage guidelines, seeRate
11915 # balancing mode and Utilization
11916 # balancing mode.
11917 #
11918 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11919 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
11920 # guidelines, seeRate
11921 # balancing mode and Utilization
11922 # balancing mode.
11923 #
11924 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11925 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
11926 # guidelines, seeRate
11927 # balancing mode and Utilization
11928 # balancing mode.
11929 #
11930 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11931 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
11932 #
11933 # For usage guidelines, seeUtilization
11934 # balancing mode.
11935 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
11936 # the backend.
11937 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
11938 },
11939 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
11940 # sending traffic to backends with default preference. The possible values
11941 # are:
11942 #
11943 # - PREFERRED: Backends with this preference level will be
11944 # filled up to their capacity limits first, based on RTT.
11945 # - DEFAULT: If preferred backends don&#x27;t have enough
11946 # capacity, backends in this layer would be used and traffic would be
11947 # assigned based on the load balancing algorithm you use. This is the
11948 # default
11949 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
11950 # Attachment).
11951 # e.g.
11952 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
11953 # for Cloud Run service.
11954 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
11955 # for PSC Service Attachment.
11956 &quot;trafficDuration&quot;: &quot;A String&quot;,
11957 },
11958 ],
11959 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
11960 # specified load balancer types.
11961 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
11962 # Pragma or Authorization headers. Up to 5 headers can be specified.
11963 # The cache is bypassed for all cdnPolicy.cacheMode settings.
11964 { # Bypass the cache when the specified request headers are present,
11965 # e.g. Pragma or Authorization headers. Values are case insensitive.
11966 # The presence of such a header overrides the cache_mode setting.
11967 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
11968 # Values are case-insensitive.
11969 },
11970 ],
11971 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
11972 # CDN.
11973 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
11974 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
11975 &quot;A String&quot;,
11976 ],
11977 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
11978 # The name=value pair will be used in the cache key Cloud CDN generates.
11979 &quot;A String&quot;,
11980 ],
11981 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
11982 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
11983 # query_string_whitelist and query_string_blacklist. If neither is set, the
11984 # entire query string will be included. If false, the query string will be
11985 # excluded from the cache key entirely.
11986 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
11987 # parameters will be included. Either specify query_string_whitelist or
11988 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
11989 # not treated as delimiters.
11990 &quot;A String&quot;,
11991 ],
11992 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
11993 # parameters will be excluded. Either specify query_string_whitelist or
11994 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
11995 # not treated as delimiters.
11996 &quot;A String&quot;,
11997 ],
11998 },
11999 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
12000 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
12001 # headers to cache content. Responses without these headers will not be
12002 # cached at Google&#x27;s edge, and will require a full trip to the origin on
12003 # every request, potentially impacting performance and increasing load on
12004 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
12005 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
12006 # Warning: this may result in Cloud CDN caching private,
12007 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
12008 # including common image formats, media (video and audio), and web assets
12009 # (JavaScript and CSS). Requests and responses that are marked as
12010 # uncacheable, as well as dynamic content (including HTML), will not be
12011 # cached.
12012 #
12013 # If no value is provided for cdnPolicy.cacheMode, it defaults
12014 # to CACHE_ALL_STATIC.
12015 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
12016 # used to clamp the max-age (or Expires) value sent to the client. With
12017 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
12018 # response max-age directive, along with a &quot;public&quot; directive. For
12019 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
12020 # from the origin (if specified), or else sets the response max-age
12021 # directive to the lesser of the client_ttl and default_ttl, and also
12022 # ensures a &quot;public&quot; cache-control directive is present.
12023 # If a client TTL is not specified, a default value (1 hour) will be used.
12024 # The maximum allowed value is 31,622,400s (1 year).
12025 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
12026 # responses that do not have an existing valid TTL (max-age or s-maxage).
12027 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
12028 # The value of defaultTTL cannot be set to a value greater than that of
12029 # maxTTL, but can be equal.
12030 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
12031 # will overwrite the TTL set in all responses. The maximum allowed value is
12032 # 31,622,400s (1 year), noting that infrequently accessed objects may be
12033 # evicted from the cache before the defined TTL.
12034 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
12035 # origin.
12036 # Cache directives that attempt to set a max-age or s-maxage higher than
12037 # this, or an Expires header more than maxTTL seconds in the future will
12038 # be capped at the value of maxTTL, as if it were the value of an
12039 # s-maxage Cache-Control directive.
12040 # Headers sent to the client will not be modified.
12041 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
12042 # The maximum allowed value is 31,622,400s (1 year), noting that
12043 # infrequently accessed objects may be evicted from the cache before
12044 # the defined TTL.
12045 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
12046 # to apply fine-grained caching for common errors or redirects.
12047 # This can reduce the load on your origin and improve end-user
12048 # experience by reducing response latency.
12049 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
12050 # negative caching applies to responses with the specified response code
12051 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
12052 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
12053 # to all responses with the specified response code, and override any
12054 # caching headers.
12055 # By default, Cloud CDN will apply the following default TTLs to these
12056 # status codes:
12057 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
12058 # HTTP 404 (Not Found), 410 (Gone),
12059 # 451 (Unavailable For Legal Reasons): 120s
12060 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
12061 # These defaults can be overridden in negative_caching_policy.
12062 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
12063 # negative_caching must be enabled to configure negative_caching_policy.
12064 # Omitting the policy and leaving negative_caching enabled will use
12065 # Cloud CDN&#x27;s default cache TTLs.
12066 # Note that when specifying an explicit negative_caching_policy, you
12067 # should take care to specify a cache TTL for all response codes
12068 # that you wish to cache. Cloud CDN will not apply any default
12069 # negative caching when a policy exists.
12070 { # Specify CDN TTLs for response error codes.
12071 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
12072 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
12073 # specified as values, and you cannot specify a status code more than
12074 # once.
12075 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
12076 # corresponding status code.
12077 # The maximum allowed value is 1800s (30 minutes), noting that
12078 # infrequently accessed objects may be evicted from the cache before the
12079 # defined TTL.
12080 },
12081 ],
12082 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
12083 # requests into a small number of requests to the origin.
12084 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
12085 # content with the origin, or when an error is encountered when refreshing
12086 # the cache.
12087 # This setting defines the default &quot;max-stale&quot; duration for any cached
12088 # responses that do not specify a max-stale directive. Stale responses that
12089 # exceed the TTL configured here will not be served. The default limit
12090 # (max-stale) is 86400s (1 day), which will allow stale content to be
12091 # served up to this limit beyond the max-age (or s-maxage) of a cached
12092 # response.
12093 # The maximum allowed value is 604800 (1 week).
12094 # Set this to zero (0) to disable serve-while-stale.
12095 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
12096 # considered fresh. After this time period, the response will be
12097 # revalidated before being served. Defaults to 1hr (3600s). When serving
12098 # responses to signed URL requests, Cloud CDN will internally behave as
12099 # though all responses from this backend had a &quot;Cache-Control:
12100 # public, max-age=[TTL]&quot; header, regardless of any existing
12101 # Cache-Control header. The actual headers served in responses will not be
12102 # altered.
12103 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
12104 &quot;A String&quot;,
12105 ],
12106 },
12107 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
12108 # backend service.
12109 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
12110 # as a count of seconds and fractions of seconds at nanosecond
12111 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12112 # or &quot;month&quot;. Range is approximately 10,000 years.
12113 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12114 # Durations less than one second are represented with a 0
12115 # `seconds` field and a positive `nanos` field. Must be from 0
12116 # to 999,999,999 inclusive.
12117 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12118 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12119 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12120 },
12121 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
12122 # there is no limit.
12123 #
12124 # Not supported when the backend service is referenced by a URL map that is
12125 # bound to target gRPC proxy that has validateForProxyless field set to true.
12126 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
12127 # not specified, there is no limit.
12128 #
12129 # Not supported when the backend service is referenced by a URL map that is
12130 # bound to target gRPC proxy that has validateForProxyless field set to true.
12131 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
12132 # service. If not specified, there is no limit.
12133 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
12134 # This parameter is respected by both the HTTP/1.1 and HTTP/2
12135 # implementations. If not specified, there is no limit. Setting this
12136 # parameter to 1 will effectively disable keep alive.
12137 #
12138 # Not supported when the backend service is referenced by a URL map that is
12139 # bound to target gRPC proxy that has validateForProxyless field set to true.
12140 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
12141 # not specified, the default is 1.
12142 #
12143 # Not supported when the backend service is referenced by a URL map that is
12144 # bound to target gRPC proxy that has validateForProxyless field set to true.
12145 },
12146 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
12147 # the client&#x27;s Accept-Encoding header.
12148 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
12149 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
12150 # instance. For supported load balancers and protocols, as described inEnabling
12151 # connection draining.
12152 },
12153 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
12154 # tracking policy settings are only available for external passthrough
12155 # Network Load Balancers and internal passthrough Network Load Balancers.
12156 #
12157 # connectionTrackingPolicy cannot be specified with haPolicy.
12158 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
12159 # value is DEFAULT_FOR_PROTOCOL.
12160 #
12161 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
12162 # persist on unhealthy backends only for connection-oriented protocols
12163 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
12164 # Affinity is configured for 5-tuple. They do not persist forUDP.
12165 #
12166 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
12167 # the existing connections on the unhealthy backend are never persisted on
12168 # the unhealthy backend. They are always diverted to newly selected healthy
12169 # backends (unless all backends are unhealthy).
12170 #
12171 # If set to ALWAYS_PERSIST, existing connections always
12172 # persist on unhealthy backends regardless of protocol and session
12173 # affinity. It is generally not recommended to use this mode overriding the
12174 # default.
12175 #
12176 # For more details, see [Connection Persistence for Network Load
12177 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
12178 # and [Connection Persistence for Internal TCP/UDP Load
12179 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
12180 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
12181 # Balancers. This option is not available publicly.
12182 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
12183 # matching traffic (in seconds).
12184 #
12185 # For internal passthrough Network Load Balancers:
12186 #
12187 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
12188 # - It can be set only if Connection Tracking is less than 5-tuple
12189 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
12190 # Mode is PER_SESSION).
12191 #
12192 #
12193 #
12194 # For external passthrough Network Load Balancers the default is 60
12195 # seconds. This option is not available publicly.
12196 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
12197 # options:
12198 #
12199 # - PER_CONNECTION: This is the default mode. The Connection
12200 # Tracking is performed as per the Connection Key (default Hash Method) for
12201 # the specific protocol.
12202 # - PER_SESSION: The Connection Tracking is performed as per
12203 # the configured Session Affinity. It matches the configured Session
12204 # Affinity.
12205 #
12206 #
12207 #
12208 # For more details, see [Tracking Mode for Network Load
12209 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
12210 # and [Tracking Mode for Internal TCP/UDP Load
12211 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
12212 },
12213 &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
12214 # affinity based on HTTP headers, cookies or other properties. This load
12215 # balancing policy is applicable only for HTTP connections. The affinity to a
12216 # particular destination host will be lost when one or more hosts are
12217 # added/removed from the destination service. This field specifies parameters
12218 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
12219 #
12220 # This field is applicable to either:
12221 #
12222 # - A regional backend service with the service protocol set to HTTP,
12223 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
12224 # INTERNAL_MANAGED.
12225 # - A global backend service with the
12226 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
12227 &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
12228 # be used as the hash key for the consistent hash load balancer. If the
12229 # cookie is not present, it will be generated. This field is applicable if
12230 # the sessionAffinity is set to HTTP_COOKIE.
12231 #
12232 # Not supported when the backend service is referenced by a URL map that is
12233 # bound to target gRPC proxy that has validateForProxyless field set to true.
12234 # for load balancing policies that use a consistent hash.
12235 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
12236 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
12237 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
12238 # as a count of seconds and fractions of seconds at nanosecond
12239 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12240 # or &quot;month&quot;. Range is approximately 10,000 years.
12241 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12242 # Durations less than one second are represented with a 0
12243 # `seconds` field and a positive `nanos` field. Must be from 0
12244 # to 999,999,999 inclusive.
12245 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12246 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12247 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12248 },
12249 },
12250 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
12251 # applicable if the sessionAffinity is set toHEADER_FIELD.
12252 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
12253 # 1024. Larger ring sizes result in more granular load distributions. If the
12254 # number of hosts in the load balancing pool is larger than the ring size,
12255 # each host will be assigned a single virtual node.
12256 },
12257 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
12258 # text format.
12259 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
12260 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
12261 # locality_lb_policy.
12262 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
12263 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
12264 # long and match the regular expression
12265 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
12266 # first character must be a lowercase letter, and all following
12267 # characters must be a dash, period, underscore, lowercase letter, or
12268 # digit, except the last character, which cannot be a dash, period, or
12269 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
12270 # field can only be used for a global or regional backend service with the
12271 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
12272 },
12273 ],
12274 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
12275 # custom
12276 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
12277 &quot;A String&quot;,
12278 ],
12279 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
12280 # custom
12281 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
12282 &quot;A String&quot;,
12283 ],
12284 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
12285 # create the resource.
12286 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
12287 # backend service with dynamic forwarding feature which together with Service
12288 # Extension allows customized and complex routing logic.
12289 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
12290 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
12291 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
12292 },
12293 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
12294 # service. Some ranges are restricted: Restricted
12295 # ranges.
12296 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
12297 },
12298 },
12299 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
12300 # this backend service.
12301 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
12302 # global external Application Load Balancer.
12303 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
12304 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
12305 #
12306 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
12307 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
12308 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
12309 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
12310 # externalManagedMigrationTestingPercentage.
12311 #
12312 # Rolling back a migration requires the states to be set in reverse order. So
12313 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
12314 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
12315 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
12316 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
12317 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
12318 # external Application Load Balancer.
12319 #
12320 # The value of this field must be in the range [0, 100].
12321 #
12322 # Session affinity options will slightly affect this routing behavior, for
12323 # more details, see:Session
12324 # Affinity.
12325 #
12326 # This value can only be set if the loadBalancingScheme in the BackendService
12327 # is set to EXTERNAL (when using the classic Application Load Balancer) and
12328 # the migration state is TEST_BY_PERCENTAGE.
12329 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
12330 # as a backup (failover) backend.
12331 # For load balancers that have configurable failover:
12332 # [Internal passthrough Network Load
12333 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12334 # and [external passthrough Network Load
12335 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12336 #
12337 # failoverPolicy cannot be specified with haPolicy.
12338 # failover:
12339 # [Internal passthrough Network Load
12340 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12341 # and [external passthrough
12342 # Network Load
12343 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12344 # On failover or failback, this field indicates whether connection draining
12345 # will be honored. Google Cloud has a fixed connection draining timeout of
12346 # 10 minutes. A setting of true terminates existing TCP
12347 # connections to the active pool during failover and failback, immediately
12348 # draining traffic. A setting of false allows existing TCP
12349 # connections to persist, even on VMs no longer in the active pool, for up
12350 # to the duration of the connection draining timeout (10 minutes).
12351 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
12352 #
12353 # The default is false.
12354 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
12355 # load balancer are dropped when all primary and all backup backend VMs are
12356 # unhealthy.If set to false, connections are distributed
12357 # among all primary VMs when all primary and all backup backend VMs are
12358 # unhealthy.
12359 # For load balancers that have configurable
12360 # failover:
12361 # [Internal passthrough
12362 # Network Load
12363 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12364 # and [external passthrough
12365 # Network Load
12366 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12367 # The default is false.
12368 &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
12369 # failover when the number of healthy primary VMs equals zero.
12370 # For all other values, the load balancer performs a failover when the
12371 # total number of healthy primary VMs is less than this ratio.
12372 # For load balancers that have configurable
12373 # failover:
12374 # [Internal TCP/UDP Load
12375 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12376 # and [external TCP/UDP Load
12377 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12378 },
12379 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
12380 # This field is used in optimistic locking. This field will be ignored when
12381 # inserting a BackendService. An up-to-date fingerprint must be provided in
12382 # order to update the BackendService, otherwise the request will
12383 # fail with error 412 conditionNotMet.
12384 #
12385 # To see the latest fingerprint, make a get() request to
12386 # retrieve a BackendService.
12387 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
12388 # Protocol Forwarding.
12389 #
12390 # The backends of this regional backend service must only specify zonal
12391 # network endpoint groups (NEGs) of type GCE_VM_IP.
12392 #
12393 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
12394 # regional backend service must set the network field. All zonal NEGs must
12395 # belong to the same network. However, individual NEGs can
12396 # belong to different subnetworks of that network.
12397 #
12398 # When haPolicy is specified, the set of attached network endpoints across
12399 # all backends comprise an High Availability domain from which one endpoint
12400 # is selected as the active endpoint (the leader) that receives all
12401 # traffic.
12402 #
12403 # haPolicy can be added only at backend service creation time. Once set up,
12404 # it cannot be deleted.
12405 #
12406 # Note that haPolicy is not for load balancing, and therefore cannot be
12407 # specified with sessionAffinity, connectionTrackingPolicy, and
12408 # failoverPolicy.
12409 #
12410 # haPolicy requires customers to be responsible for tracking backend
12411 # endpoint health and electing a leader among the healthy endpoints.
12412 # Therefore, haPolicy cannot be specified with healthChecks.
12413 #
12414 # haPolicy can only be specified for External Passthrough Network Load
12415 # Balancers and Internal Passthrough Network Load Balancers.
12416 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
12417 # achieve it.
12418 #
12419 # Supported values are:
12420 #
12421 # - DISABLED: Fast IP Move is disabled. You can only use the
12422 # haPolicy.leader API to update the leader.
12423 # - &gt;GARP_RA: Provides a method to very quickly define a new network
12424 # endpoint as the leader. This method is faster than updating the leader
12425 # using the haPolicy.leader API. Fast IP move works as follows: The VM
12426 # hosting the network endpoint that should become the new leader sends
12427 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
12428 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
12429 # temporarily associates the forwarding rule IP address with that VM, and
12430 # both new and in-flight packets are quickly delivered to that VM.
12431 #
12432 #
12433 #
12434 # Note the important properties of the Fast IP Move functionality:
12435 #
12436 # - The GARP/RA-initiated re-routing stays active for approximately 20
12437 # minutes. After triggering fast failover, you must also
12438 # appropriately set the haPolicy.leader.
12439 # - The new leader instance should continue to send GARP/RA packets
12440 # periodically every 10 seconds until at least 10 minutes after updating
12441 # the haPolicy.leader (but stop immediately if it is no longer the leader).
12442 # - After triggering a fast failover, we recommend that you wait at least
12443 # 3 seconds before sending another GARP/RA packet from a different VM
12444 # instance to avoid race conditions.
12445 # - Don&#x27;t send GARP/RA packets from different VM
12446 # instances at the same time. If multiple instances continue to send
12447 # GARP/RA packets, traffic might be routed to different destinations in an
12448 # alternating order. This condition ceases when a single instance
12449 # issues a GARP/RA packet.
12450 # - The GARP/RA request always takes priority over the leader API.
12451 # Using the haPolicy.leader API to change the leader to a different
12452 # instance will have no effect until the GARP/RA request becomes
12453 # inactive.
12454 # - The GARP/RA packets should follow the GARP/RA
12455 # Packet Specifications..
12456 # - When multiple forwarding rules refer to a regional backend service,
12457 # you need only send a GARP or RA packet for a single forwarding rule
12458 # virtual IP. The virtual IPs for all forwarding rules targeting the same
12459 # backend service will also be moved to the sender of the GARP or RA
12460 # packet.
12461 #
12462 #
12463 #
12464 # The following are the Fast IP Move limitations (that is, when fastIPMove
12465 # is not DISABLED):
12466 #
12467 # - Multiple forwarding rules cannot use the same IP address if one of
12468 # them refers to a regional backend service with fastIPMove.
12469 # - The regional backend service must set the network field, and all
12470 # NEGs must belong to that network. However, individual
12471 # NEGs can belong to different subnetworks of that network.
12472 # - The maximum number of network endpoints across all backends of a
12473 # backend service with fastIPMove is 32.
12474 # - The maximum number of backend services with fastIPMove that can have
12475 # the same network endpoint attached to one of its backends is 64.
12476 # - The maximum number of backend services with fastIPMove in a VPC in a
12477 # region is 64.
12478 # - The network endpoints that are attached to a backend of a backend
12479 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
12480 # - Traffic directed to the leader by a static route next hop will not be
12481 # redirected to a new leader by fast failover. Such traffic will only be
12482 # redirected once an haPolicy.leader update has taken effect. Only traffic
12483 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
12484 # fast failover.
12485 #
12486 #
12487 # haPolicy.fastIPMove can be set only at backend service creation time.
12488 # Once set, it cannot be updated.
12489 #
12490 # By default, fastIpMove is set to DISABLED.
12491 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
12492 # this service as the active endpoint (the leader) that receives all
12493 # traffic.
12494 #
12495 # When the leader changes, there is no connection draining to persist
12496 # existing connections on the old leader.
12497 #
12498 # You are responsible for selecting a suitable endpoint as the
12499 # leader. For example, preferring a healthy endpoint over unhealthy ones.
12500 # Note that this service does not track backend endpoint health, and
12501 # selects the configured leader unconditionally.
12502 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
12503 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
12504 # that the leader is attached to.
12505 #
12506 # The leader&#x27;s backendGroup must already be specified as a backend of
12507 # this backend service. Removing a backend that is designated as the
12508 # leader&#x27;s backendGroup is not permitted.
12509 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
12510 # designated as the leader.
12511 #
12512 # This network endpoint cannot be detached from the NEG specified in
12513 # the haPolicy.leader.backendGroup until the leader is updated with
12514 # another network endpoint, or the leader is removed from the haPolicy.
12515 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
12516 # instance must already be attached to the NEG specified in the
12517 # haPolicy.leader.backendGroup.
12518 #
12519 # The name must be 1-63 characters long, and comply with RFC1035.
12520 # Authorization requires the following IAM permission on the
12521 # specified resource instance: compute.instances.use
12522 },
12523 },
12524 },
12525 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
12526 # httpsHealthChecks (legacy) resource for health checking this backend
12527 # service. Not all backend services support legacy health checks. See
12528 # Load balancer guide. Currently, at most one health check can be
12529 # specified for each backend service. Backend services with
12530 # instance group or zonal NEG backends must have a health check unless
12531 # haPolicy is specified. Backend services with internet or serverless NEG
12532 # backends must not have a health check.
12533 #
12534 # healthChecks[] cannot be specified with haPolicy.
12535 &quot;A String&quot;,
12536 ],
12537 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
12538 # Not available for internal passthrough Network Load Balancers and external
12539 # passthrough Network Load Balancers.
12540 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
12541 # incoming requests.
12542 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
12543 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
12544 # for IAP.
12545 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
12546 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
12547 # Optional - If not provided, the name will be autogenerated by the
12548 # backend.
12549 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
12550 },
12551 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
12552 # For security reasons, this value cannot be retrieved via the API.
12553 # Instead, the SHA-256 hash of the value is returned in the
12554 # oauth2ClientSecretSha256 field.
12555 #
12556 # @InputOnly
12557 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
12558 },
12559 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
12560 # defined by the server.
12561 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
12562 # from the client to the backend for proxyless gRPC).
12563 # The possible values are:
12564 #
12565 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
12566 # backend service (Instance Group, Managed Instance Group, Network Endpoint
12567 # Group), regardless of traffic from the client to the proxy. Only IPv4
12568 # health checks are used to check the health of the backends. This is the
12569 # default setting.
12570 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
12571 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
12572 # address).
12573 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
12574 # backend service (Instance Group, Managed Instance Group, Network Endpoint
12575 # Group), regardless of traffic from the client to the proxy. Only IPv6
12576 # health checks are used to check the health of the backends.
12577 #
12578 #
12579 #
12580 # This field is applicable to either:
12581 #
12582 # - Advanced global external Application Load Balancer (load balancing
12583 # scheme EXTERNAL_MANAGED),
12584 # - Regional external Application Load
12585 # Balancer,
12586 # - Internal proxy Network Load Balancer (load balancing
12587 # scheme INTERNAL_MANAGED),
12588 # - Regional internal Application Load
12589 # Balancer (load balancing scheme INTERNAL_MANAGED),
12590 # - Traffic
12591 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
12592 # INTERNAL_SELF_MANAGED).
12593 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
12594 # for backend services.
12595 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
12596 # created for one type of load balancer cannot be used with another.
12597 # For more information, refer toChoosing
12598 # a load balancer.
12599 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
12600 # preference. When you use localityLbPolicies, you must set at least one
12601 # value for either the localityLbPolicies[].policy or the
12602 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
12603 # value set in the localityLbPolicy field.
12604 #
12605 # For an example of how to use this field, seeDefine
12606 # a list of preferred policies.
12607 #
12608 # Caution: This field and its children are intended for use in a service mesh
12609 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
12610 # that have this configuration.
12611 { # Container for either a built-in LB policy supported by gRPC or Envoy or
12612 # a custom one implemented by the end user.
12613 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
12614 # deployed with the client.
12615 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
12616 # by a locally installed custom policy implementation.
12617 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
12618 #
12619 # The value should match the name of a custom implementation registered
12620 # on the gRPC clients. It should follow protocol buffer message naming
12621 # conventions and include the full path (for example,
12622 # myorg.CustomLbPolicy). The maximum length is 256 characters.
12623 #
12624 # Do not specify the same custom policy more than once for a
12625 # backend. If you do, the configuration is rejected.
12626 #
12627 # For an example of how to use this field, seeUse
12628 # a custom policy.
12629 },
12630 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
12631 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
12632 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
12633 # about these values, see the description of localityLbPolicy.
12634 #
12635 # Do not specify the same policy more than once for a
12636 # backend. If you do, the configuration is rejected.
12637 },
12638 },
12639 ],
12640 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
12641 # possible values are:
12642 #
12643 # - ROUND_ROBIN: This is a simple policy in which each healthy
12644 # backend is selected in round robin order. This is the default.
12645 # - LEAST_REQUEST: An O(1) algorithm which
12646 # selects two random healthy hosts and picks the host which has fewer active
12647 # requests.
12648 # - RING_HASH: The ring/modulo hash load balancer implements
12649 # consistent hashing to backends. The algorithm has the property that the
12650 # addition/removal of a host from a set of N hosts only affects 1/N of the
12651 # requests.
12652 # - RANDOM: The load balancer selects a random healthy
12653 # host.
12654 # - ORIGINAL_DESTINATION: Backend host is selected
12655 # based on the client connection metadata, i.e., connections are opened to
12656 # the same address as the destination address of the incoming connection
12657 # before the connection was redirected to the load balancer.
12658 # - MAGLEV: used as a drop in replacement for the ring hash
12659 # load balancer. Maglev is not as stable as ring hash but has faster table
12660 # lookup build times and host selection times. For more information about
12661 # Maglev, see Maglev:
12662 # A Fast and Reliable Software Network Load Balancer.
12663 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
12664 # Load Balancing using weights computed from Backend reported Custom Metrics.
12665 # If set, the Backend Service responses are expected to contain non-standard
12666 # HTTP response header field Endpoint-Load-Metrics. The reported
12667 # metrics to use for computing the weights are specified via thecustomMetrics field.
12668 #
12669 # This field is applicable to either:
12670 # - A regional backend service with the service protocol set to HTTP,
12671 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
12672 # INTERNAL_MANAGED.
12673 # - A global backend service with the
12674 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
12675 # EXTERNAL_MANAGED.
12676 #
12677 #
12678 # If sessionAffinity is not configured—that is, if session
12679 # affinity remains at the default value of NONE—then the
12680 # default value for localityLbPolicy
12681 # is ROUND_ROBIN. If session affinity is set to a value other
12682 # than NONE,
12683 # then the default value for localityLbPolicy isMAGLEV.
12684 #
12685 # Only ROUND_ROBIN and RING_HASH are supported
12686 # when the backend service is referenced by a URL map that is bound to
12687 # target gRPC proxy that has validateForProxyless field set to true.
12688 #
12689 # localityLbPolicy cannot be specified with haPolicy.
12690 &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
12691 # by this backend service. If logging is enabled, logs will be exported to
12692 # Stackdriver.
12693 # backend service.
12694 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
12695 # traffic served by this backend service. The default value is false.
12696 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
12697 { # Determines which HTTP headers will be logged to Stackdriver.
12698 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
12699 },
12700 ],
12701 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
12702 { # Determines which HTTP headers will be logged to Stackdriver.
12703 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
12704 },
12705 ],
12706 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
12707 # This field can only be specified if logging is enabled for this backend
12708 # service. Configures whether all, none or a subset of optional fields
12709 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
12710 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
12711 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
12712 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
12713 # of optional fields you want to include in the logs. For example:
12714 # serverInstance, serverGkeDetails.cluster,
12715 # serverGkeDetails.pod.podNamespace
12716 &quot;A String&quot;,
12717 ],
12718 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
12719 # service. Configures whether all, none or a subset of optional fields
12720 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
12721 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
12722 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
12723 # service. The value of the field must be in [0, 1]. This configures the
12724 # sampling rate of requests to the load balancer where 1.0 means all logged
12725 # requests are reported and 0.0 means no logged requests are reported. The
12726 # default value is 1.0.
12727 },
12728 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
12729 # service. Duration is computed from the beginning of the stream until the
12730 # response has been completely processed, including all retries. A stream
12731 # that does not complete in this duration is closed.
12732 #
12733 # If not specified, there will be no timeout limit, i.e. the maximum
12734 # duration is infinite.
12735 #
12736 # This value can be overridden in the PathMatcher configuration of the
12737 # UrlMap that references this backend service.
12738 #
12739 # This field is only allowed when the loadBalancingScheme of
12740 # the backend service is INTERNAL_SELF_MANAGED.
12741 # as a count of seconds and fractions of seconds at nanosecond
12742 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12743 # or &quot;month&quot;. Range is approximately 10,000 years.
12744 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12745 # Durations less than one second are represented with a 0
12746 # `seconds` field and a positive `nanos` field. Must be from 0
12747 # to 999,999,999 inclusive.
12748 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12749 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12750 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12751 },
12752 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
12753 # controller and read by the backend RCTH
12754 &quot;a_key&quot;: &quot;A String&quot;,
12755 },
12756 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
12757 # The name must be 1-63 characters long, and comply withRFC1035.
12758 # Specifically, the name must be 1-63 characters long and match the regular
12759 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
12760 # character must be a lowercase letter, and all following characters must
12761 # be a dash, lowercase letter, or digit, except the last character, which
12762 # cannot be a dash.
12763 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
12764 #
12765 # This field must be set for Internal Passthrough Network Load Balancers when
12766 # the haPolicy is enabled, and for External Passthrough Network Load
12767 # Balancers when the haPolicy fastIpMove is enabled.
12768 #
12769 # 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.
12770 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
12771 # Load Balancers.
12772 #
12773 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
12774 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
12775 # endpoints in the local zone.
12776 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
12777 # possible values are:
12778 #
12779 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
12780 # is disabled. The load balancer distributes new connections to all
12781 # healthy backend endpoints across all zones.
12782 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
12783 # enabled. The load balancer distributes new connections to all healthy
12784 # backend endpoints in the local zone only. If there are no healthy
12785 # backend endpoints in the local zone, the load balancer distributes
12786 # new connections to all backend endpoints in the local zone.
12787 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
12788 # enabled. The load balancer distributes new connections to all healthy
12789 # backend endpoints in the local zone only. If there aren&#x27;t enough
12790 # healthy backend endpoints in the local zone, the load balancer
12791 # distributes new connections to all healthy backend endpoints across all
12792 # zones.
12793 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
12794 # of healthy backend endpoints in a zone to the count of backend
12795 # endpoints in that same zone is equal to or above this threshold, the
12796 # load balancer distributes new connections to all healthy endpoints in
12797 # the local zone only. When the ratio of the count of healthy backend
12798 # endpoints in a zone to the count of backend endpoints in that same
12799 # zone is below this threshold, the load balancer distributes all new
12800 # connections to all healthy endpoints across all zones.
12801 },
12802 },
12803 &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.
12804 # the backend service.
12805 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
12806 # service.
12807 },
12808 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
12809 # load balancing pool of each individual proxy instance that processes the
12810 # traffic for the given backend service. If not set, this feature is
12811 # considered disabled.
12812 #
12813 # Results of the outlier detection algorithm (ejection of endpoints from the
12814 # load balancing pool and returning them back to the pool) are executed
12815 # independently by each proxy instance of the load balancer. In most cases,
12816 # more than one proxy instance handles the traffic received by a backend
12817 # service. Thus, it is possible that an unhealthy endpoint is detected and
12818 # ejected by only some of the proxies, and while this happens, other proxies
12819 # may continue to send requests to the same unhealthy endpoint until they
12820 # detect and eject the unhealthy endpoint.
12821 #
12822 # Applicable backend endpoints can be:
12823 #
12824 # - VM instances in an Instance Group
12825 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
12826 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
12827 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
12828 # Functions Services
12829 # - Private Service Connect NEGs, that resolve to
12830 # Google-managed regional API endpoints or managed services published using
12831 # Private Service Connect
12832 #
12833 #
12834 #
12835 # Applicable backend service types can be:
12836 #
12837 # - A global backend service with the loadBalancingScheme set to
12838 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
12839 # - A regional backend
12840 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
12841 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
12842 # supported for Serverless NEGs.
12843 #
12844 #
12845 #
12846 # Not supported when the backend service is referenced by a URL map that is
12847 # bound to target gRPC proxy that has validateForProxyless field set to true.
12848 # pool for the backend service.
12849 &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
12850 # or 30s.
12851 #
12852 # After a backend endpoint is returned back to the load balancing pool, it
12853 # can be ejected again in another ejection analysis. Thus, the total ejection
12854 # time is equal to the base ejection time multiplied by the number of times
12855 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
12856 # as a count of seconds and fractions of seconds at nanosecond
12857 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12858 # or &quot;month&quot;. Range is approximately 10,000 years.
12859 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12860 # Durations less than one second are represented with a 0
12861 # `seconds` field and a positive `nanos` field. Must be from 0
12862 # to 999,999,999 inclusive.
12863 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12864 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12865 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12866 },
12867 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
12868 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
12869 # return code qualifies as an error. Defaults to 5.
12870 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
12871 # connection errors that are mapped to one of those status codes) before a
12872 # consecutive gateway failure ejection occurs. Defaults to 3.
12873 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12874 # outlier status is detected through consecutive 5xx. This setting can be
12875 # used to disable ejection or to ramp it up slowly. Defaults to 0.
12876 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12877 # outlier status is detected through consecutive gateway failures. This
12878 # setting can be used to disable ejection or to ramp it up slowly. Defaults
12879 # to 100.
12880 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12881 # outlier status is detected through success rate statistics. This setting
12882 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
12883 #
12884 # Not supported when the backend service uses Serverless NEG.
12885 &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
12886 # ejections and backend endpoints being returned to service. The interval is
12887 # equal to the number of seconds as defined in
12888 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
12889 # in outlierDetection.interval.nanos. Defaults to 1 second.
12890 # as a count of seconds and fractions of seconds at nanosecond
12891 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12892 # or &quot;month&quot;. Range is approximately 10,000 years.
12893 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12894 # Durations less than one second are represented with a 0
12895 # `seconds` field and a positive `nanos` field. Must be from 0
12896 # to 999,999,999 inclusive.
12897 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12898 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12899 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12900 },
12901 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
12902 # backend service that can be ejected if the ejection conditions are met.
12903 # Defaults to 50%.
12904 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
12905 # enough request volume to detect success rate outliers. If the number of
12906 # backend endpoints is fewer than this setting, outlier detection via success
12907 # rate statistics is not performed for any backend endpoint in the load
12908 # balancing pool. Defaults to 5.
12909 #
12910 # Not supported when the backend service uses Serverless NEG.
12911 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
12912 # (as defined by the interval duration above) to include this backend
12913 # endpoint in success rate based outlier detection. If the volume is lower
12914 # than this setting, outlier detection via success rate statistics is not
12915 # performed for that backend endpoint. Defaults to 100.
12916 #
12917 # Not supported when the backend service uses Serverless NEG.
12918 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
12919 # outlier ejection. The ejection threshold is the difference between the mean
12920 # success rate, and the product of this factor and the standard deviation of
12921 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
12922 # is divided by a thousand to get a double. That is, if the desired factor
12923 # is 1.9, the runtime value should be 1900. Defaults to 1900.
12924 #
12925 # Not supported when the backend service uses Serverless NEG.
12926 },
12927 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
12928 # as part of resource payload.
12929 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
12930 # Tag keys and values have the same definition as resource
12931 # manager tags. The field is allowed for INSERT
12932 # only. The keys/values to set on the resource should be specified in
12933 # either ID { : } or Namespaced format
12934 # { : }.
12935 # For example the following are valid inputs:
12936 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
12937 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
12938 # Note:
12939 # * Invalid combinations of ID &amp; namespaced format is not supported. For
12940 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
12941 &quot;a_key&quot;: &quot;A String&quot;,
12942 },
12943 },
12944 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
12945 # the backend. The default value is 80.
12946 # For internal passthrough Network Load Balancers and external passthrough
12947 # Network Load Balancers, omit port.
12948 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
12949 # communication to the backend VMs in that group. The
12950 # named port must be [defined on each backend instance
12951 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
12952 # This parameter has no meaning if the backends are NEGs. For internal
12953 # passthrough Network Load Balancers and external passthrough Network Load
12954 # Balancers, omit port_name.
12955 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
12956 # with backends.
12957 #
12958 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
12959 # depending on the chosen load balancer or Traffic Director configuration.
12960 # Refer to the documentation for the load balancers or for Traffic Director
12961 # for more information.
12962 #
12963 # Must be set to GRPC when the backend service is referenced by a URL map
12964 # that is bound to target gRPC proxy.
12965 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
12966 # resides. This field is not applicable to global backend services.
12967 # You must specify this field as part of the HTTP request URL. It is
12968 # not settable as a field in the request body.
12969 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
12970 # backend service.
12971 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
12972 # service. This field is applicable to a global backend service with the
12973 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
12974 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
12975 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
12976 # be accepted on backends, and if authenticated, which method/certificate
12977 # will set the request principal.
12978 # request principal.
12979 # The authentication settings for the backend service.
12980 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
12981 # Similar to peers, these will be evaluated in order the first valid one
12982 # will be used to set origin identity. If none of these methods pass, the
12983 # request will be rejected with authentication failed error (401). Leave the
12984 # list empty if origin authentication is not required.
12985 { # [Deprecated] Configuration for the origin authentication method.
12986 # Configuration for the origin authentication method.
12987 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
12988 # JWT configuration for origin authentication.
12989 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
12990 # will be accepted if audiences is empty.
12991 # Examples: bookstore_android.apps.googleusercontent.com,
12992 # bookstore_web.apps.googleusercontent.com
12993 &quot;A String&quot;,
12994 ],
12995 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
12996 # email address.
12997 # Examples: https://securetoken.google.com,
12998 # [email protected]
12999 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
13000 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
13001 # request. If no explicit location is specified, the following default
13002 # locations are tried in order:
13003 #
13004 # 1. The Authorization header using the Bearer schema. See `here
13005 # `_. Example:
13006 #
13007 # Authorization: Bearer .
13008 #
13009 # 2. `access_token` query parameter. See `this
13010 # `_
13011 #
13012 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
13013 # from the locations its issuer specified or from the default locations.
13014 #
13015 # This field is set if JWT is sent in a request header. This field specifies
13016 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
13017 # header format will be x-goog-iap-jwt-assertion: .
13018 { # [Deprecated] This message specifies a header location to extract JWT token.
13019 # This message specifies a header location to extract JWT token.
13020 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
13021 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
13022 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
13023 # with a space at the end.
13024 },
13025 ],
13026 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
13027 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
13028 # JWT format in the query parameter is /path?jwt_token=.
13029 &quot;A String&quot;,
13030 ],
13031 },
13032 },
13033 ],
13034 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
13035 # They will be evaluated in order the first valid one will be used to set
13036 # peer identity. If none of these methods pass, the request will be rejected
13037 # with authentication failed error (401). Leave the list empty if peer
13038 # authentication is not required.
13039 { # [Deprecated] Configuration for the peer authentication method.
13040 # Configuration for the peer authentication method.
13041 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
13042 # Configuration for the mutual Tls mode for peer authentication.
13043 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
13044 # field can be set to one of the following:
13045 # STRICT: Client certificate must be presented, connection is in TLS.
13046 # PERMISSIVE: Client certificate can be omitted, connection can be either
13047 # plaintext or TLS.
13048 },
13049 },
13050 ],
13051 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
13052 # Default value is USE_PEER. If peer (or origin) identity is not available,
13053 # either because peer/origin authentication is not defined, or failed,
13054 # principal will be left unset. In other words, binding rule does not affect
13055 # the decision to accept or reject request. This field can be set to one of
13056 # the following:
13057 # USE_PEER: Principal will be set to the identity from peer authentication.
13058 # USE_ORIGIN: Principal will be set to the identity from origin
13059 # authentication.
13060 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
13061 # identity information.
13062 # The TLS settings for the client or server.
13063 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
13064 # certificate.
13065 # Defines the mechanism to obtain the client or server certificate.
13066 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
13067 # applicable only if tlsCertificateSource is set to USE_PATH.
13068 # The paths to the mounted TLS Certificates and private key.
13069 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13070 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13071 },
13072 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13073 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13074 # is applicable only if tlsCertificateSource is set to USE_SDS.
13075 # The configuration to access the SDS server.
13076 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13077 # gRPC config to access the SDS server.
13078 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13079 # gRPC call credentials to access the SDS server.
13080 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13081 # This field can be set to one of the following:
13082 #
13083 # - GCE_VM: The local GCE VM service account credentials are used to access
13084 # the SDS server.
13085 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13086 # SDS server.
13087 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13088 # FROM_PLUGIN.
13089 # Custom authenticator credentials.
13090 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13091 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13092 # plugin.
13093 },
13094 },
13095 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13096 # gRPC channel credentials to access the SDS server.
13097 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13098 # The paths to the mounted TLS Certificates and private key.
13099 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13100 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13101 },
13102 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13103 # to one of the following:
13104 # CERTIFICATES: Use TLS certificates to access the SDS server.
13105 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13106 },
13107 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13108 },
13109 },
13110 },
13111 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
13112 # validate the client/server certificate. If omitted, the proxy will not
13113 # validate the server or client certificate.
13114 # certificate to validate the client/server certificate.
13115 # validate the client/server certificate.
13116 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
13117 # client or server certificate.
13118 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13119 # is applicable only if tlsCertificateSource is set to USE_SDS.
13120 # The configuration to access the SDS server.
13121 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13122 # gRPC config to access the SDS server.
13123 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13124 # gRPC call credentials to access the SDS server.
13125 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13126 # This field can be set to one of the following:
13127 #
13128 # - GCE_VM: The local GCE VM service account credentials are used to access
13129 # the SDS server.
13130 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13131 # SDS server.
13132 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13133 # FROM_PLUGIN.
13134 # Custom authenticator credentials.
13135 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13136 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13137 # plugin.
13138 },
13139 },
13140 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13141 # gRPC channel credentials to access the SDS server.
13142 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13143 # The paths to the mounted TLS Certificates and private key.
13144 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13145 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13146 },
13147 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13148 # to one of the following:
13149 # CERTIFICATES: Use TLS certificates to access the SDS server.
13150 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13151 },
13152 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13153 },
13154 },
13155 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13156 },
13157 },
13158 },
13159 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
13160 # (RBAC) config.
13161 # Authorization config defines the Role Based Access Control (RBAC) config.
13162 # method-level access control for a service.
13163 # control for a service.
13164 &quot;policies&quot;: [ # List of RbacPolicies.
13165 {
13166 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
13167 &quot;permissions&quot;: [ # The list of permissions.
13168 { # [Deprecated] All fields defined in a permission are ANDed.
13169 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
13170 { # Custom constraint that specifies a key and a list of allowed values for
13171 # Istio attributes.
13172 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
13173 &quot;values&quot;: [ # A list of allowed values.
13174 &quot;A String&quot;,
13175 ],
13176 },
13177 ],
13178 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
13179 # applies to. Exact match, prefix match, and suffix match are supported.
13180 &quot;A String&quot;,
13181 ],
13182 &quot;methods&quot;: [ # HTTP method.
13183 &quot;A String&quot;,
13184 ],
13185 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
13186 &quot;A String&quot;,
13187 ],
13188 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
13189 &quot;A String&quot;,
13190 ],
13191 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
13192 &quot;A String&quot;,
13193 ],
13194 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
13195 &quot;A String&quot;,
13196 ],
13197 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
13198 # Exact match, prefix match, and suffix match are supported.
13199 &quot;A String&quot;,
13200 ],
13201 &quot;ports&quot;: [ # Port names or numbers.
13202 &quot;A String&quot;,
13203 ],
13204 },
13205 ],
13206 &quot;principals&quot;: [ # The list of principals.
13207 { # [Deprecated] All fields defined in a principal are ANDed.
13208 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
13209 &quot;groups&quot;: [ # The groups the principal belongs to.
13210 # Exact match, prefix match, and suffix match are supported.
13211 &quot;A String&quot;,
13212 ],
13213 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
13214 &quot;A String&quot;,
13215 ],
13216 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
13217 &quot;A String&quot;,
13218 ],
13219 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
13220 &quot;A String&quot;,
13221 ],
13222 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
13223 &quot;A String&quot;,
13224 ],
13225 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
13226 &quot;A String&quot;,
13227 ],
13228 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
13229 &quot;A String&quot;,
13230 ],
13231 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
13232 # suffix match are supported for values. For example,
13233 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
13234 &quot;a_key&quot;: &quot;A String&quot;,
13235 },
13236 &quot;users&quot;: [ # The user names/IDs or service accounts.
13237 # Exact match, prefix match, and suffix match are supported.
13238 &quot;A String&quot;,
13239 ],
13240 },
13241 ],
13242 },
13243 ],
13244 },
13245 &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
13246 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
13247 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
13248 # private storage buckets that support Signature Version 4 for authentication.
13249 # The service name for generating the authentication header will always default
13250 # to &#x27;s3&#x27;.
13251 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
13252 # creating a backend that uses AWS v4 signature authentication, but will not
13253 # be returned as part of the configuration when queried with a REST API GET
13254 # request.
13255 #
13256 # @InputOnly
13257 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
13258 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
13259 # keep track of different iterations of your access key.
13260 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
13261 # the name of the region your cloud uses to host your origin. For example,
13262 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
13263 },
13264 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
13265 # that describes how clients should authenticate with this service&#x27;s
13266 # backends.
13267 #
13268 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
13269 # to INTERNAL_SELF_MANAGED.
13270 #
13271 # If left blank, communications are not encrypted.
13272 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
13273 # originating from the backend service.
13274 # the backend service.
13275 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
13276 # identity information. This field is only applicable when mode is set to
13277 # MUTUAL.
13278 # The TLS settings for the client or server.
13279 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
13280 # certificate.
13281 # Defines the mechanism to obtain the client or server certificate.
13282 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
13283 # applicable only if tlsCertificateSource is set to USE_PATH.
13284 # The paths to the mounted TLS Certificates and private key.
13285 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13286 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13287 },
13288 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13289 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13290 # is applicable only if tlsCertificateSource is set to USE_SDS.
13291 # The configuration to access the SDS server.
13292 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13293 # gRPC config to access the SDS server.
13294 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13295 # gRPC call credentials to access the SDS server.
13296 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13297 # This field can be set to one of the following:
13298 #
13299 # - GCE_VM: The local GCE VM service account credentials are used to access
13300 # the SDS server.
13301 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13302 # SDS server.
13303 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13304 # FROM_PLUGIN.
13305 # Custom authenticator credentials.
13306 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13307 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13308 # plugin.
13309 },
13310 },
13311 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13312 # gRPC channel credentials to access the SDS server.
13313 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13314 # The paths to the mounted TLS Certificates and private key.
13315 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13316 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13317 },
13318 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13319 # to one of the following:
13320 # CERTIFICATES: Use TLS certificates to access the SDS server.
13321 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13322 },
13323 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13324 },
13325 },
13326 },
13327 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
13328 # validate the client/server certificate. If omitted, the proxy will not
13329 # validate the server or client certificate.
13330 # certificate to validate the client/server certificate.
13331 # validate the client/server certificate.
13332 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
13333 # client or server certificate.
13334 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13335 # is applicable only if tlsCertificateSource is set to USE_SDS.
13336 # The configuration to access the SDS server.
13337 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13338 # gRPC config to access the SDS server.
13339 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13340 # gRPC call credentials to access the SDS server.
13341 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13342 # This field can be set to one of the following:
13343 #
13344 # - GCE_VM: The local GCE VM service account credentials are used to access
13345 # the SDS server.
13346 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13347 # SDS server.
13348 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13349 # FROM_PLUGIN.
13350 # Custom authenticator credentials.
13351 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13352 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13353 # plugin.
13354 },
13355 },
13356 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13357 # gRPC channel credentials to access the SDS server.
13358 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13359 # The paths to the mounted TLS Certificates and private key.
13360 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13361 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13362 },
13363 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13364 # to one of the following:
13365 # CERTIFICATES: Use TLS certificates to access the SDS server.
13366 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13367 },
13368 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13369 },
13370 },
13371 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13372 },
13373 },
13374 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
13375 # The value of this field determines how TLS is enforced. This can be set
13376 # to one of the following values: DISABLE: Do not setup a TLS connection to
13377 # the backends.
13378 # SIMPLE: Originate a TLS connection to the backends.
13379 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
13380 # client certificates for authentication.
13381 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
13382 # applicable only when mode is SIMPLE or MUTUAL.
13383 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
13384 # certificate.If specified,
13385 # the proxy will verify that the server certificate&#x27;s subject alt name
13386 # matches one of the specified values. This field is applicable only when
13387 # mode is SIMPLE or MUTUAL.
13388 &quot;A String&quot;,
13389 ],
13390 },
13391 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
13392 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
13393 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
13394 # specified values, the communication continues. Otherwise, it fails. This
13395 # additional check enables the client to verify that the server is authorized
13396 # to run the requested service.
13397 #
13398 # Note that the contents of the server
13399 # certificate&#x27;s subjectAltName field are configured by the
13400 # Public Key Infrastructure which provisions server identities.
13401 #
13402 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
13403 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
13404 # mode).
13405 &quot;A String&quot;,
13406 ],
13407 },
13408 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13409 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
13410 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
13411 #
13412 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
13413 # If set, lists of backends and health checks must be both empty.
13414 &quot;A String&quot;,
13415 ],
13416 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
13417 #
13418 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
13419 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
13420 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
13421 #
13422 # Only NONE and HEADER_FIELD are supported
13423 # when the backend service is referenced by a URL map that is bound to
13424 # target gRPC proxy that has validateForProxyless field set to true.
13425 #
13426 # For more details, see:
13427 # [Session
13428 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
13429 #
13430 # sessionAffinity cannot be specified with haPolicy.
13431 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
13432 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
13433 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
13434 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
13435 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
13436 # as a count of seconds and fractions of seconds at nanosecond
13437 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13438 # or &quot;month&quot;. Range is approximately 10,000 years.
13439 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13440 # Durations less than one second are represented with a 0
13441 # `seconds` field and a positive `nanos` field. Must be from 0
13442 # to 999,999,999 inclusive.
13443 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13444 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13445 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13446 },
13447 },
13448 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
13449 # Currently this is applicable only for Internal TCP/UDP load balancing,
13450 # Internal HTTP(S) load balancing and Traffic Director.
13451 &quot;policy&quot;: &quot;A String&quot;,
13452 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
13453 # each service mesh client.
13454 #
13455 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
13456 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
13457 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
13458 # `INTERNAL_SELF_MANAGED`.
13459 #
13460 # `subset_size` is optional for Internal HTTP(S) load balancing
13461 # and required for Traffic Director.
13462 #
13463 # If you do not provide this value, Cloud Load Balancing will calculate it
13464 # dynamically to optimize the number of proxies/clients visible to each
13465 # backend and vice versa.
13466 #
13467 # Must be greater than 0. If `subset_size` is larger than the number of
13468 # backends/endpoints, then subsetting is disabled.
13469 },
13470 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
13471 # type of load balancer. For more information see,
13472 # Backend service settings.
13473 # The default is 30 seconds.
13474 # The full range of timeout values allowed goes from 1
13475 # through 2,147,483,647 seconds.
13476 #
13477 # This value can be overridden in the PathMatcher configuration of the
13478 # UrlMap that references this backend service.
13479 #
13480 # Not supported when the backend service is referenced by a URL map that is
13481 # bound to target gRPC proxy that has validateForProxyless field set to true.
13482 # Instead, use maxStreamDuration.
13483 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
13484 # when the backend protocol is SSL, HTTPS or HTTP2.
13485 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
13486 # networksecurity.googleapis.com namespace. Can be used in authenticating
13487 # TLS connections to the backend, as specified by the authenticationMode
13488 # field. Can only be specified if authenticationMode is not NONE.
13489 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
13490 #
13491 #
13492 # Use this property to configure the load balancer back-end to use
13493 # certificates and roots of trust provisioned by the Managed Workload
13494 # Identity system.
13495 #
13496 # The `identity` property is the
13497 # fully-specified SPIFFE ID to use in the SVID presented by the Load
13498 # Balancer Workload.
13499 #
13500 # The SPIFFE ID must be a resource starting with the
13501 # `trustDomain` property value, followed by the path to the Managed
13502 # Workload Identity.
13503 #
13504 # Supported SPIFFE ID format:
13505 #
13506 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
13507 #
13508 #
13509 # The Trust Domain within the Managed Identity must refer to a valid
13510 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
13511 # will be inherited from the Workload Identity Pool.
13512 #
13513 # Restrictions:
13514 #
13515 # - If you set the `identity` property, you cannot manually set
13516 # the following fields:
13517 # - tlsSettings.sni
13518 # - tlsSettings.subjectAltNames
13519 # - tlsSettings.authenticationConfig
13520 #
13521 #
13522 # When defining a `identity` for a RegionBackendServices, the
13523 # corresponding Workload Identity Pool must have a ca_pool
13524 # configured in the same region.
13525 #
13526 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
13527 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
13528 # balancer sends this string as the SNI hostname in the TLS connection to
13529 # the backend, and requires that this string match a Subject Alternative
13530 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
13531 # NEG backend, if the SNI is specified here, the load balancer uses it
13532 # regardless of whether the Regional Internet NEG is specified with FQDN or
13533 # IP address and port. When both sni and subjectAltNames[] are specified,
13534 # the load balancer matches the backend certificate&#x27;s SAN only to
13535 # subjectAltNames[].
13536 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
13537 # verifies during a TLS handshake with the backend. When the server
13538 # presents its X.509 certificate to the Load Balancer, the Load Balancer
13539 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
13540 # match one of the subjectAltNames in the list. This field is limited to 5
13541 # entries. When both sni and subjectAltNames[] are specified, the load
13542 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
13543 { # A Subject Alternative Name that the load balancer matches against the SAN
13544 # field in the TLS certificate provided by the backend, specified as either
13545 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
13546 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
13547 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
13548 },
13549 ],
13550 },
13551 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
13552 {
13553 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
13554 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
13555 # and ForwardingRule.
13556 },
13557 ],
13558 }
13559
13560 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13561 that if you must retry your request, the server will know to ignore the
13562 request if it has already been completed.
13563
13564 For example, consider a situation where you make an initial request and
13565 the request times out. If you make the request again with the same
13566 request ID, the server can check if original operation with the same
13567 request ID was received, and if so, will ignore the second request. This
13568 prevents clients from accidentally creating duplicate commitments.
13569
13570 The request ID must be
13571 a valid UUID with the exception that zero UUID is not supported
13572 (00000000-0000-0000-0000-000000000000).
13573 x__xgafv: string, V1 error format.
13574 Allowed values
13575 1 - v1 error format
13576 2 - v2 error format
13577
13578 Returns:
13579 An object of the form:
13580
13581 { # Represents an Operation resource.
13582 #
13583 # Google Compute Engine has three Operation resources:
13584 #
13585 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
13586 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
13587 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
13588 #
13589 # You can use an operation resource to manage asynchronous API requests.
13590 # For more information, readHandling
13591 # API responses.
13592 #
13593 # Operations can be global, regional or zonal.
13594 #
13595 # - For global operations, use the `globalOperations`
13596 # resource.
13597 # - For regional operations, use the
13598 # `regionOperations` resource.
13599 # - For zonal operations, use
13600 # the `zoneOperations` resource.
13601 #
13602 #
13603 #
13604 # For more information, read
13605 # Global, Regional, and Zonal Resources.
13606 #
13607 # Note that completed Operation resources have a limited
13608 # retention period.
13609 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13610 # Not present otherwise.
13611 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13612 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13613 # set when the operation is created.
13614 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13615 # text format.
13616 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13617 # this field will be populated.
13618 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13619 # operation.
13620 {
13621 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13622 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13623 # details. There is a set of defined message types to use for providing
13624 # details.The syntax depends on the error code. For example,
13625 # QuotaExceededInfo will have details when the error code is
13626 # QUOTA_EXCEEDED.
13627 {
13628 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13629 #
13630 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13631 # is not enabled:
13632 #
13633 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13634 # &quot;domain&quot;: &quot;googleapis.com&quot;
13635 # &quot;metadata&quot;: {
13636 # &quot;resource&quot;: &quot;projects/123&quot;,
13637 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13638 # }
13639 # }
13640 #
13641 # This response indicates that the pubsub.googleapis.com API is not enabled.
13642 #
13643 # Example of an error that is returned when attempting to create a Spanner
13644 # instance in a region that is out of stock:
13645 #
13646 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13647 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13648 # &quot;metadata&quot;: {
13649 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13650 # }
13651 # }
13652 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13653 # is typically the registered service name of the tool or product that
13654 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13655 # generated by some common infrastructure, the error domain must be a
13656 # globally unique value that identifies the infrastructure. For Google API
13657 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13658 &quot;metadatas&quot;: { # Additional structured details about this error.
13659 #
13660 # Keys must match a regular expression of `a-z+` but should
13661 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13662 # length. When identifying the current value of an exceeded limit, the units
13663 # should be contained in the key, not the value. For example, rather than
13664 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13665 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13666 # instances that can be created in a single (batch) request.
13667 &quot;a_key&quot;: &quot;A String&quot;,
13668 },
13669 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13670 # proximate cause of the error. Error reasons are unique within a particular
13671 # domain of errors. This should be at most 63 characters and match a
13672 # regular expression of `A-Z+[A-Z0-9]`, which represents
13673 # UPPER_SNAKE_CASE.
13674 },
13675 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13676 #
13677 # For example, if a quota check failed with an error indicating the calling
13678 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13679 # directly to the right place in the developer console to flip the bit.
13680 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13681 { # Describes a URL link.
13682 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13683 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13684 },
13685 ],
13686 },
13687 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13688 # which can be attached to an RPC error.
13689 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13690 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13691 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13692 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13693 },
13694 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13695 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13696 &quot;a_key&quot;: &quot;A String&quot;,
13697 },
13698 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13699 # type or metric.
13700 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13701 # or metric.
13702 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13703 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13704 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13705 },
13706 },
13707 ],
13708 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13709 # This property is optional.
13710 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13711 },
13712 ],
13713 },
13714 &quot;getVersionOperationMetadata&quot;: {
13715 &quot;inlineSbomInfo&quot;: {
13716 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13717 # appropriate identifiers.
13718 &quot;a_key&quot;: &quot;A String&quot;,
13719 },
13720 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13721 # identifiers.
13722 &quot;a_key&quot;: &quot;A String&quot;,
13723 },
13724 },
13725 },
13726 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13727 # message that was returned, such as `NOT FOUND`.
13728 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13729 # status code that was returned. For example, a `404` means the
13730 # resource was not found.
13731 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13732 # defined by the server.
13733 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13734 # This value is inRFC3339
13735 # text format.
13736 &quot;instancesBulkInsertOperationMetadata&quot;: {
13737 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13738 # Example key: zones/us-central1-a
13739 &quot;a_key&quot;: {
13740 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13741 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13742 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13743 # error.
13744 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13745 # if the flow is rolling forward or rolling back.
13746 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13747 },
13748 },
13749 },
13750 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13751 # Operation resources.
13752 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13753 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13754 # group of operations results from a `bulkInsert` API request.
13755 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13756 # `update`, or `delete`, and so on.
13757 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13758 # There is no requirement that this be linear or support any granularity of
13759 # operations. This should not be used to guess when the operation will be
13760 # complete. This number should monotonically increase as the operation
13761 # progresses.
13762 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13763 # applicable when performing regional operations.
13764 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13765 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
13766 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13767 # this field will contain information on all underlying zonal actions and
13768 # their state.
13769 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13770 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13771 # Example key: zones/us-central1-a
13772 &quot;a_key&quot;: {
13773 &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
13774 # populated.
13775 # different programming environments, including REST APIs and RPC APIs. It is
13776 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13777 # three pieces of data: error code, error message, and error details.
13778 #
13779 # You can find out more about this error model and how to work with it in the
13780 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13781 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13782 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13783 # message types for APIs to use.
13784 {
13785 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13786 },
13787 ],
13788 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13789 # user-facing error message should be localized and sent in the
13790 # google.rpc.Status.details field, or localized by the client.
13791 },
13792 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13793 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13794 },
13795 },
13796 },
13797 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13798 # This value is inRFC3339
13799 # text format.
13800 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13801 # following:
13802 # `PENDING`, `RUNNING`, or `DONE`.
13803 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13804 # operation.
13805 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13806 # of the target resource.
13807 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13808 # operations related to creating a snapshot, this points to the disk
13809 # that the snapshot was created from.
13810 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13811 # `[email protected]` or
13812 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13813 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13814 # operation, this field will be populated.
13815 {
13816 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13817 # Engine returns NO_RESULTS_ON_PAGE if there
13818 # are no results in the response.
13819 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13820 # value format. For example:
13821 #
13822 # &quot;data&quot;: [
13823 # {
13824 # &quot;key&quot;: &quot;scope&quot;,
13825 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13826 # }
13827 {
13828 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13829 # returned. For example, for warnings where there are no results in a list
13830 # request for a particular zone, this key might be scope and
13831 # the key value might be the zone name. Other examples might be a key
13832 # indicating a deprecated resource and a suggested replacement, or a
13833 # warning about invalid network settings (for example, if an instance
13834 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13835 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13836 },
13837 ],
13838 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13839 },
13840 ],
13841 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13842 # applicable when performing per-zone operations.
13843 }</pre>
13844 </div>
13845
13846 </body></html>