Debian Codegraph @

docs/dyn/compute_alpha.backendServices.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.backendServices.html">backendServices</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds a key for validating requests with signed URLs for this backend</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves the list of all BackendService resources, regional and global,</p>
83 <p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#close">close()</a></code></p>
88 <p class="firstline">Close httplib2 connections.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(project, backendService, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes the specified BackendService resource.</p>
92 <p class="toc_element">
93 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes a key for validating requests with signed URLs for this backend</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, backendService, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified BackendService resource.</p>
98 <p class="toc_element">
99 <code><a href="#getEffectiveSecurityPolicies">getEffectiveSecurityPolicies(project, backendService, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns effective security policies applied to this backend service.</p>
101 <p class="toc_element">
102 <code><a href="#getHealth">getHealth(project, backendService, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Gets the most recent health check results for this</p>
104 <p class="toc_element">
105 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
107 <p class="toc_element">
108 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Creates a BackendService resource in the specified project using</p>
110 <p class="toc_element">
111 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Retrieves the list of BackendService resources available to the specified</p>
113 <p class="toc_element">
114 <code><a href="#listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Retrieves a list of all usable backend services in the specified project.</p>
116 <p class="toc_element">
117 <code><a href="#listUsable_next">listUsable_next()</a></code></p>
118 <p class="firstline">Retrieves the next page of results.</p>
119 <p class="toc_element">
120 <code><a href="#list_next">list_next()</a></code></p>
121 <p class="firstline">Retrieves the next page of results.</p>
122 <p class="toc_element">
123 <code><a href="#patch">patch(project, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Patches the specified BackendService resource with the data included in the</p>
125 <p class="toc_element">
126 <code><a href="#setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Sets the edge security policy for the specified backend service.</p>
128 <p class="toc_element">
129 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Sets the access control policy on the specified resource.</p>
131 <p class="toc_element">
132 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Sets the Google Cloud Armor security policy for the specified backend</p>
134 <p class="toc_element">
135 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
137 <p class="toc_element">
138 <code><a href="#update">update(project, backendService, body=None, requestId=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Updates the specified BackendService resource with the data included in the</p>
140 <h3>Method Details</h3>
141 <div class="method">
142 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
143 <pre>Adds a key for validating requests with signed URLs for this backend
144 service.
145
146 Args:
147 project: string, Project ID for this request. (required)
148 backendService: string, Name of the BackendService resource to which the Signed URL Key should be
149 added. The name should conform to RFC1035. (required)
150 body: object, The request body.
151 The object takes the form of:
152
153 { # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
154 &quot;keyName&quot;: &quot;A String&quot;, # Name of the key. The name must be 1-63 characters long, and comply withRFC1035.
155 # Specifically, the name must be 1-63 characters long and match the regular
156 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
157 # character must be a lowercase letter, and all following characters must
158 # be a dash, lowercase letter, or digit, except the last character, which
159 # cannot be a dash.
160 &quot;keyValue&quot;: &quot;A String&quot;, # 128-bit key value used for signing the URL. The key value must be a validRFC
161 # 4648 Section 5 base64url encoded string.
162 }
163
164 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
165 that if you must retry your request, the server will know to ignore the
166 request if it has already been completed.
167
168 For example, consider a situation where you make an initial request and
169 the request times out. If you make the request again with the same
170 request ID, the server can check if original operation with the same
171 request ID was received, and if so, will ignore the second request. This
172 prevents clients from accidentally creating duplicate commitments.
173
174 The request ID must be
175 a valid UUID with the exception that zero UUID is not supported
176 (00000000-0000-0000-0000-000000000000).
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182 Returns:
183 An object of the form:
184
185 { # Represents an Operation resource.
186 #
187 # Google Compute Engine has three Operation resources:
188 #
189 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
190 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
191 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
192 #
193 # You can use an operation resource to manage asynchronous API requests.
194 # For more information, readHandling
195 # API responses.
196 #
197 # Operations can be global, regional or zonal.
198 #
199 # - For global operations, use the `globalOperations`
200 # resource.
201 # - For regional operations, use the
202 # `regionOperations` resource.
203 # - For zonal operations, use
204 # the `zoneOperations` resource.
205 #
206 #
207 #
208 # For more information, read
209 # Global, Regional, and Zonal Resources.
210 #
211 # Note that completed Operation resources have a limited
212 # retention period.
213 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
214 # Not present otherwise.
215 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
216 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
217 # set when the operation is created.
218 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
219 # text format.
220 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
221 # this field will be populated.
222 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
223 # operation.
224 {
225 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
226 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
227 # details. There is a set of defined message types to use for providing
228 # details.The syntax depends on the error code. For example,
229 # QuotaExceededInfo will have details when the error code is
230 # QUOTA_EXCEEDED.
231 {
232 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
233 #
234 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
235 # is not enabled:
236 #
237 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
238 # &quot;domain&quot;: &quot;googleapis.com&quot;
239 # &quot;metadata&quot;: {
240 # &quot;resource&quot;: &quot;projects/123&quot;,
241 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
242 # }
243 # }
244 #
245 # This response indicates that the pubsub.googleapis.com API is not enabled.
246 #
247 # Example of an error that is returned when attempting to create a Spanner
248 # instance in a region that is out of stock:
249 #
250 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
251 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
252 # &quot;metadata&quot;: {
253 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
254 # }
255 # }
256 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
257 # is typically the registered service name of the tool or product that
258 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
259 # generated by some common infrastructure, the error domain must be a
260 # globally unique value that identifies the infrastructure. For Google API
261 # infrastructure, the error domain is &quot;googleapis.com&quot;.
262 &quot;metadatas&quot;: { # Additional structured details about this error.
263 #
264 # Keys must match a regular expression of `a-z+` but should
265 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
266 # length. When identifying the current value of an exceeded limit, the units
267 # should be contained in the key, not the value. For example, rather than
268 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
269 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
270 # instances that can be created in a single (batch) request.
271 &quot;a_key&quot;: &quot;A String&quot;,
272 },
273 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
274 # proximate cause of the error. Error reasons are unique within a particular
275 # domain of errors. This should be at most 63 characters and match a
276 # regular expression of `A-Z+[A-Z0-9]`, which represents
277 # UPPER_SNAKE_CASE.
278 },
279 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
280 #
281 # For example, if a quota check failed with an error indicating the calling
282 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
283 # directly to the right place in the developer console to flip the bit.
284 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
285 { # Describes a URL link.
286 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
287 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
288 },
289 ],
290 },
291 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
292 # which can be attached to an RPC error.
293 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
294 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
295 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
296 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
297 },
298 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
299 &quot;dimensions&quot;: { # The map holding related quota dimensions.
300 &quot;a_key&quot;: &quot;A String&quot;,
301 },
302 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
303 # type or metric.
304 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
305 # or metric.
306 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
307 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
308 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
309 },
310 },
311 ],
312 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
313 # This property is optional.
314 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
315 },
316 ],
317 },
318 &quot;getVersionOperationMetadata&quot;: {
319 &quot;inlineSbomInfo&quot;: {
320 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
321 # appropriate identifiers.
322 &quot;a_key&quot;: &quot;A String&quot;,
323 },
324 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
325 # identifiers.
326 &quot;a_key&quot;: &quot;A String&quot;,
327 },
328 },
329 },
330 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
331 # message that was returned, such as `NOT FOUND`.
332 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
333 # status code that was returned. For example, a `404` means the
334 # resource was not found.
335 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
336 # defined by the server.
337 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
338 # This value is inRFC3339
339 # text format.
340 &quot;instancesBulkInsertOperationMetadata&quot;: {
341 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
342 # Example key: zones/us-central1-a
343 &quot;a_key&quot;: {
344 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
345 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
346 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
347 # error.
348 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
349 # if the flow is rolling forward or rolling back.
350 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
351 },
352 },
353 },
354 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
355 # Operation resources.
356 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
357 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
358 # group of operations results from a `bulkInsert` API request.
359 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
360 # `update`, or `delete`, and so on.
361 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
362 # There is no requirement that this be linear or support any granularity of
363 # operations. This should not be used to guess when the operation will be
364 # complete. This number should monotonically increase as the operation
365 # progresses.
366 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
367 # applicable when performing regional operations.
368 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
369 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
370 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
371 # this field will contain information on all underlying zonal actions and
372 # their state.
373 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
374 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
375 # Example key: zones/us-central1-a
376 &quot;a_key&quot;: {
377 &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
378 # populated.
379 # different programming environments, including REST APIs and RPC APIs. It is
380 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
381 # three pieces of data: error code, error message, and error details.
382 #
383 # You can find out more about this error model and how to work with it in the
384 # [API Design Guide](https://cloud.google.com/apis/design/errors).
385 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
386 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
387 # message types for APIs to use.
388 {
389 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
390 },
391 ],
392 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
393 # user-facing error message should be localized and sent in the
394 # google.rpc.Status.details field, or localized by the client.
395 },
396 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
397 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
398 },
399 },
400 },
401 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
402 # This value is inRFC3339
403 # text format.
404 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
405 # following:
406 # `PENDING`, `RUNNING`, or `DONE`.
407 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
408 # operation.
409 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
410 # of the target resource.
411 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
412 # operations related to creating a snapshot, this points to the disk
413 # that the snapshot was created from.
414 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
415 # `[email protected]` or
416 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
417 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
418 # operation, this field will be populated.
419 {
420 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
421 # Engine returns NO_RESULTS_ON_PAGE if there
422 # are no results in the response.
423 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
424 # value format. For example:
425 #
426 # &quot;data&quot;: [
427 # {
428 # &quot;key&quot;: &quot;scope&quot;,
429 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
430 # }
431 {
432 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
433 # returned. For example, for warnings where there are no results in a list
434 # request for a particular zone, this key might be scope and
435 # the key value might be the zone name. Other examples might be a key
436 # indicating a deprecated resource and a suggested replacement, or a
437 # warning about invalid network settings (for example, if an instance
438 # attempts to perform IP forwarding but is not enabled for IP forwarding).
439 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
440 },
441 ],
442 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
443 },
444 ],
445 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
446 # applicable when performing per-zone operations.
447 }</pre>
448 </div>
449
450 <div class="method">
451 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
452 <pre>Retrieves the list of all BackendService resources, regional and global,
453 available to the specified project.
454
455 To prevent failure, it is recommended that you set the
456 `returnPartialSuccess` parameter to `true`.
457
458 Args:
459 project: string, Name of the project scoping this request. (required)
460 filter: string, A filter expression that filters resources listed in the response. Most
461 Compute resources support two types of filter expressions:
462 expressions that support regular expressions and expressions that follow
463 API improvement proposal AIP-160.
464 These two types of filter expressions cannot be mixed in one request.
465
466 If you want to use AIP-160, your expression must specify the field name, an
467 operator, and the value that you want to use for filtering. The value
468 must be a string, a number, or a boolean. The operator
469 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
470
471 For example, if you are filtering Compute Engine instances, you can
472 exclude instances named `example-instance` by specifying
473 `name != example-instance`.
474
475 The `:*` comparison can be used to test whether a key has been defined.
476 For example, to find all objects with `owner` label use:
477 ```
478 labels.owner:*
479 ```
480
481 You can also filter nested fields. For example, you could specify
482 `scheduling.automaticRestart = false` to include instances only
483 if they are not scheduled for automatic restarts. You can use filtering
484 on nested fields to filter based onresource labels.
485
486 To filter on multiple expressions, provide each separate expression within
487 parentheses. For example:
488 ```
489 (scheduling.automaticRestart = true)
490 (cpuPlatform = &quot;Intel Skylake&quot;)
491 ```
492 By default, each expression is an `AND` expression. However, you
493 can include `AND` and `OR` expressions explicitly.
494 For example:
495 ```
496 (cpuPlatform = &quot;Intel Skylake&quot;) OR
497 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
498 (scheduling.automaticRestart = true)
499 ```
500
501 If you want to use a regular expression, use the `eq` (equal) or `ne`
502 (not equal) operator against a single un-parenthesized expression with or
503 without quotes or against multiple parenthesized expressions. Examples:
504
505 `fieldname eq unquoted literal`
506 `fieldname eq &#x27;single quoted literal&#x27;`
507 `fieldname eq &quot;double quoted literal&quot;`
508 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
509
510 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
511 The literal value must match the entire field.
512
513 For example, to filter for instances that do not end with name &quot;instance&quot;,
514 you would use `name ne .*instance`.
515
516 You cannot combine constraints on multiple fields using regular
517 expressions.
518 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
519 global) should be included in the response. For new resource types added
520 after this field, the flag has no effect as new resource types will always
521 include every visible scope for each scope type in response. For resource
522 types which predate this field, if this flag is omitted or false, only
523 scopes of the scope types where the resource type is expected to be found
524 will be included.
525 maxResults: integer, The maximum number of results per page that should be returned.
526 If the number of available results is larger than `maxResults`,
527 Compute Engine returns a `nextPageToken` that can be used to get
528 the next page of results in subsequent list requests. Acceptable values are
529 `0` to `500`, inclusive. (Default: `500`)
530 orderBy: string, Sorts list results by a certain order. By default, results
531 are returned in alphanumerical order based on the resource name.
532
533 You can also sort results in descending order based on the creation
534 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
535 results based on the `creationTimestamp` field in
536 reverse chronological order (newest result first). Use this to sort
537 resources like operations so that the newest operation is returned first.
538
539 Currently, only sorting by `name` or
540 `creationTimestamp desc` is supported.
541 pageToken: string, Specifies a page token to use. Set `pageToken` to the
542 `nextPageToken` returned by a previous list request to get
543 the next page of results.
544 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
545 of failure. The default value is false.
546
547 For example, when partial success behavior is enabled, aggregatedList for a
548 single zone scope either returns all resources in the zone or no resources,
549 with an error code.
550 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
551 aggregated list request is invoked for subnetworks list-usable api.
552 x__xgafv: string, V1 error format.
553 Allowed values
554 1 - v1 error format
555 2 - v2 error format
556
557 Returns:
558 An object of the form:
559
560 { # Contains a list of BackendServicesScopedList.
561 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
562 &quot;items&quot;: { # A list of BackendServicesScopedList resources.
563 &quot;a_key&quot;: { # Name of the scope containing this set of BackendServices.
564 &quot;backendServices&quot;: [ # A list of BackendServices contained in this scope.
565 { # Represents a Backend Service resource.
566 #
567 # A backend service defines how Google Cloud load balancers distribute traffic.
568 # The backend service configuration contains a set of values, such as the
569 # protocol used to connect to backends, various distribution and session
570 # settings, health checks, and timeouts. These settings provide fine-grained
571 # control over how your load balancer behaves. Most of the settings have
572 # default values that allow for easy configuration if you need to get started
573 # quickly.
574 #
575 # Backend services in Google Compute Engine can be either regionally or
576 # globally scoped.
577 #
578 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
579 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
580 #
581 # For more information, seeBackend
582 # Services.
583 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
584 # Load Balancers and Traffic Director and requires
585 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
586 #
587 # If set to 0, the cookie is non-persistent and lasts only until
588 # the end of the browser session (or equivalent). The maximum allowed value
589 # is two weeks (1,209,600).
590 #
591 # Not supported when the backend service is referenced by a URL map that is
592 # bound to target gRPC proxy that has validateForProxyless field set to true.
593 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
594 # load balancing scheme set to INTERNAL_SELF_MANAGED.
595 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
596 { # Message containing information of one individual backend.
597 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
598 # handle additional traffic or is fully loaded. For usage guidelines, see
599 # Connection balancing mode.
600 #
601 # Backends must use compatible balancing modes. For more information, see
602 # Supported balancing modes and target capacity settings and
603 # Restrictions and guidance for instance groups.
604 #
605 # Note: Currently, if you use the API to configure incompatible balancing
606 # modes, the configuration might be accepted even though it has no impact
607 # and is ignored. Specifically, Backend.maxUtilization is ignored when
608 # Backend.balancingMode is RATE. In the future, this incompatible combination
609 # will be rejected.
610 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
611 # mode.
612 # The default value is 1, which means the group serves up to
613 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
614 # completely drained, offering 0% of its available capacity. The valid ranges
615 # are 0.0 and [0.1,1.0].
616 # You cannot configure a setting larger than 0 and smaller than0.1.
617 # You cannot configure a setting of 0 when there is only one
618 # backend attached to the backend service.
619 #
620 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
621 # internet NEGs, regional serverless NEGs, and PSC NEGs.
622 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
623 # BalancingMode.
624 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
625 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
626 # Monitoring, but is not used for load balancing.
627 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
628 # balancing mode. The valid range is [0.0, 1.0].
629 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
630 # long and match the regular expression
631 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
632 # first character must be a lowercase letter, and all following
633 # characters must be a dash, period, underscore, lowercase letter, or
634 # digit, except the last character, which cannot be a dash, period, or
635 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
636 # field can only be used for a global or regional backend service with the
637 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
638 },
639 ],
640 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
641 # create the resource.
642 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
643 # failover backend can be configured for a given BackendService.
644 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
645 # group or network endpoint
646 # group (NEG) resource. To determine what types of backends a load
647 # balancer supports, see the [Backend services
648 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
649 #
650 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
651 # or NEG. Partial URLs are not supported.
652 #
653 # If haPolicy is specified, backends must refer to NEG resources of type
654 # GCE_VM_IP.
655 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
656 # guidelines, seeConnection
657 # balancing mode and Utilization
658 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
659 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
660 # guidelines, seeConnection
661 # balancing mode and Utilization
662 # balancing mode.
663 #
664 # Not available if the backend&#x27;s balancingMode isRATE.
665 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
666 # For usage guidelines, seeConnection
667 # balancing mode and Utilization
668 # balancing mode.
669 #
670 # Not available if the backend&#x27;s balancingMode isRATE.
671 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
672 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
673 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
674 # Not available if backend&#x27;s balancingMode is RATE
675 # or CONNECTION.
676 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
677 # Not available if backend&#x27;s balancingMode is RATE
678 # or CONNECTION.
679 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
680 # usage guidelines, seeRate
681 # balancing mode and Utilization
682 # balancing mode.
683 #
684 # Not available if the backend&#x27;s balancingMode isCONNECTION.
685 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
686 # guidelines, seeRate
687 # balancing mode and Utilization
688 # balancing mode.
689 #
690 # Not available if the backend&#x27;s balancingMode isCONNECTION.
691 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
692 # guidelines, seeRate
693 # balancing mode and Utilization
694 # balancing mode.
695 #
696 # Not available if the backend&#x27;s balancingMode isCONNECTION.
697 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
698 #
699 # For usage guidelines, seeUtilization
700 # balancing mode.
701 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
702 # the backend.
703 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
704 },
705 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
706 # sending traffic to backends with default preference. The possible values
707 # are:
708 #
709 # - PREFERRED: Backends with this preference level will be
710 # filled up to their capacity limits first, based on RTT.
711 # - DEFAULT: If preferred backends don&#x27;t have enough
712 # capacity, backends in this layer would be used and traffic would be
713 # assigned based on the load balancing algorithm you use. This is the
714 # default
715 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
716 # Attachment).
717 # e.g.
718 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
719 # for Cloud Run service.
720 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
721 # for PSC Service Attachment.
722 &quot;trafficDuration&quot;: &quot;A String&quot;,
723 },
724 ],
725 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
726 # specified load balancer types.
727 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
728 # Pragma or Authorization headers. Up to 5 headers can be specified.
729 # The cache is bypassed for all cdnPolicy.cacheMode settings.
730 { # Bypass the cache when the specified request headers are present,
731 # e.g. Pragma or Authorization headers. Values are case insensitive.
732 # The presence of such a header overrides the cache_mode setting.
733 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
734 # Values are case-insensitive.
735 },
736 ],
737 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
738 # CDN.
739 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
740 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
741 &quot;A String&quot;,
742 ],
743 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
744 # The name=value pair will be used in the cache key Cloud CDN generates.
745 &quot;A String&quot;,
746 ],
747 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
748 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
749 # query_string_whitelist and query_string_blacklist. If neither is set, the
750 # entire query string will be included. If false, the query string will be
751 # excluded from the cache key entirely.
752 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
753 # parameters will be included. Either specify query_string_whitelist or
754 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
755 # not treated as delimiters.
756 &quot;A String&quot;,
757 ],
758 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
759 # parameters will be excluded. Either specify query_string_whitelist or
760 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
761 # not treated as delimiters.
762 &quot;A String&quot;,
763 ],
764 },
765 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
766 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
767 # headers to cache content. Responses without these headers will not be
768 # cached at Google&#x27;s edge, and will require a full trip to the origin on
769 # every request, potentially impacting performance and increasing load on
770 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
771 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
772 # Warning: this may result in Cloud CDN caching private,
773 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
774 # including common image formats, media (video and audio), and web assets
775 # (JavaScript and CSS). Requests and responses that are marked as
776 # uncacheable, as well as dynamic content (including HTML), will not be
777 # cached.
778 #
779 # If no value is provided for cdnPolicy.cacheMode, it defaults
780 # to CACHE_ALL_STATIC.
781 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
782 # used to clamp the max-age (or Expires) value sent to the client. With
783 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
784 # response max-age directive, along with a &quot;public&quot; directive. For
785 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
786 # from the origin (if specified), or else sets the response max-age
787 # directive to the lesser of the client_ttl and default_ttl, and also
788 # ensures a &quot;public&quot; cache-control directive is present.
789 # If a client TTL is not specified, a default value (1 hour) will be used.
790 # The maximum allowed value is 31,622,400s (1 year).
791 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
792 # responses that do not have an existing valid TTL (max-age or s-maxage).
793 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
794 # The value of defaultTTL cannot be set to a value greater than that of
795 # maxTTL, but can be equal.
796 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
797 # will overwrite the TTL set in all responses. The maximum allowed value is
798 # 31,622,400s (1 year), noting that infrequently accessed objects may be
799 # evicted from the cache before the defined TTL.
800 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
801 # origin.
802 # Cache directives that attempt to set a max-age or s-maxage higher than
803 # this, or an Expires header more than maxTTL seconds in the future will
804 # be capped at the value of maxTTL, as if it were the value of an
805 # s-maxage Cache-Control directive.
806 # Headers sent to the client will not be modified.
807 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
808 # The maximum allowed value is 31,622,400s (1 year), noting that
809 # infrequently accessed objects may be evicted from the cache before
810 # the defined TTL.
811 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
812 # to apply fine-grained caching for common errors or redirects.
813 # This can reduce the load on your origin and improve end-user
814 # experience by reducing response latency.
815 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
816 # negative caching applies to responses with the specified response code
817 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
818 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
819 # to all responses with the specified response code, and override any
820 # caching headers.
821 # By default, Cloud CDN will apply the following default TTLs to these
822 # status codes:
823 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
824 # HTTP 404 (Not Found), 410 (Gone),
825 # 451 (Unavailable For Legal Reasons): 120s
826 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
827 # These defaults can be overridden in negative_caching_policy.
828 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
829 # negative_caching must be enabled to configure negative_caching_policy.
830 # Omitting the policy and leaving negative_caching enabled will use
831 # Cloud CDN&#x27;s default cache TTLs.
832 # Note that when specifying an explicit negative_caching_policy, you
833 # should take care to specify a cache TTL for all response codes
834 # that you wish to cache. Cloud CDN will not apply any default
835 # negative caching when a policy exists.
836 { # Specify CDN TTLs for response error codes.
837 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
838 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
839 # specified as values, and you cannot specify a status code more than
840 # once.
841 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
842 # corresponding status code.
843 # The maximum allowed value is 1800s (30 minutes), noting that
844 # infrequently accessed objects may be evicted from the cache before the
845 # defined TTL.
846 },
847 ],
848 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
849 # requests into a small number of requests to the origin.
850 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
851 # content with the origin, or when an error is encountered when refreshing
852 # the cache.
853 # This setting defines the default &quot;max-stale&quot; duration for any cached
854 # responses that do not specify a max-stale directive. Stale responses that
855 # exceed the TTL configured here will not be served. The default limit
856 # (max-stale) is 86400s (1 day), which will allow stale content to be
857 # served up to this limit beyond the max-age (or s-maxage) of a cached
858 # response.
859 # The maximum allowed value is 604800 (1 week).
860 # Set this to zero (0) to disable serve-while-stale.
861 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
862 # considered fresh. After this time period, the response will be
863 # revalidated before being served. Defaults to 1hr (3600s). When serving
864 # responses to signed URL requests, Cloud CDN will internally behave as
865 # though all responses from this backend had a &quot;Cache-Control:
866 # public, max-age=[TTL]&quot; header, regardless of any existing
867 # Cache-Control header. The actual headers served in responses will not be
868 # altered.
869 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
870 &quot;A String&quot;,
871 ],
872 },
873 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
874 # backend service.
875 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
876 # as a count of seconds and fractions of seconds at nanosecond
877 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
878 # or &quot;month&quot;. Range is approximately 10,000 years.
879 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
880 # Durations less than one second are represented with a 0
881 # `seconds` field and a positive `nanos` field. Must be from 0
882 # to 999,999,999 inclusive.
883 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
884 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
885 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
886 },
887 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
888 # there is no limit.
889 #
890 # Not supported when the backend service is referenced by a URL map that is
891 # bound to target gRPC proxy that has validateForProxyless field set to true.
892 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
893 # not specified, there is no limit.
894 #
895 # Not supported when the backend service is referenced by a URL map that is
896 # bound to target gRPC proxy that has validateForProxyless field set to true.
897 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
898 # service. If not specified, there is no limit.
899 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
900 # This parameter is respected by both the HTTP/1.1 and HTTP/2
901 # implementations. If not specified, there is no limit. Setting this
902 # parameter to 1 will effectively disable keep alive.
903 #
904 # Not supported when the backend service is referenced by a URL map that is
905 # bound to target gRPC proxy that has validateForProxyless field set to true.
906 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
907 # not specified, the default is 1.
908 #
909 # Not supported when the backend service is referenced by a URL map that is
910 # bound to target gRPC proxy that has validateForProxyless field set to true.
911 },
912 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
913 # the client&#x27;s Accept-Encoding header.
914 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
915 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
916 # instance. For supported load balancers and protocols, as described inEnabling
917 # connection draining.
918 },
919 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
920 # tracking policy settings are only available for external passthrough
921 # Network Load Balancers and internal passthrough Network Load Balancers.
922 #
923 # connectionTrackingPolicy cannot be specified with haPolicy.
924 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
925 # value is DEFAULT_FOR_PROTOCOL.
926 #
927 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
928 # persist on unhealthy backends only for connection-oriented protocols
929 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
930 # Affinity is configured for 5-tuple. They do not persist forUDP.
931 #
932 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
933 # the existing connections on the unhealthy backend are never persisted on
934 # the unhealthy backend. They are always diverted to newly selected healthy
935 # backends (unless all backends are unhealthy).
936 #
937 # If set to ALWAYS_PERSIST, existing connections always
938 # persist on unhealthy backends regardless of protocol and session
939 # affinity. It is generally not recommended to use this mode overriding the
940 # default.
941 #
942 # For more details, see [Connection Persistence for Network Load
943 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
944 # and [Connection Persistence for Internal TCP/UDP Load
945 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
946 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
947 # Balancers. This option is not available publicly.
948 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
949 # matching traffic (in seconds).
950 #
951 # For internal passthrough Network Load Balancers:
952 #
953 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
954 # - It can be set only if Connection Tracking is less than 5-tuple
955 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
956 # Mode is PER_SESSION).
957 #
958 #
959 #
960 # For external passthrough Network Load Balancers the default is 60
961 # seconds. This option is not available publicly.
962 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
963 # options:
964 #
965 # - PER_CONNECTION: This is the default mode. The Connection
966 # Tracking is performed as per the Connection Key (default Hash Method) for
967 # the specific protocol.
968 # - PER_SESSION: The Connection Tracking is performed as per
969 # the configured Session Affinity. It matches the configured Session
970 # Affinity.
971 #
972 #
973 #
974 # For more details, see [Tracking Mode for Network Load
975 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
976 # and [Tracking Mode for Internal TCP/UDP Load
977 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
978 },
979 &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
980 # affinity based on HTTP headers, cookies or other properties. This load
981 # balancing policy is applicable only for HTTP connections. The affinity to a
982 # particular destination host will be lost when one or more hosts are
983 # added/removed from the destination service. This field specifies parameters
984 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
985 #
986 # This field is applicable to either:
987 #
988 # - A regional backend service with the service protocol set to HTTP,
989 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
990 # INTERNAL_MANAGED.
991 # - A global backend service with the
992 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
993 &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
994 # be used as the hash key for the consistent hash load balancer. If the
995 # cookie is not present, it will be generated. This field is applicable if
996 # the sessionAffinity is set to HTTP_COOKIE.
997 #
998 # Not supported when the backend service is referenced by a URL map that is
999 # bound to target gRPC proxy that has validateForProxyless field set to true.
1000 # for load balancing policies that use a consistent hash.
1001 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
1002 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
1003 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
1004 # as a count of seconds and fractions of seconds at nanosecond
1005 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1006 # or &quot;month&quot;. Range is approximately 10,000 years.
1007 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1008 # Durations less than one second are represented with a 0
1009 # `seconds` field and a positive `nanos` field. Must be from 0
1010 # to 999,999,999 inclusive.
1011 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1012 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1013 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1014 },
1015 },
1016 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
1017 # applicable if the sessionAffinity is set toHEADER_FIELD.
1018 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
1019 # 1024. Larger ring sizes result in more granular load distributions. If the
1020 # number of hosts in the load balancing pool is larger than the ring size,
1021 # each host will be assigned a single virtual node.
1022 },
1023 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1024 # text format.
1025 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
1026 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
1027 # locality_lb_policy.
1028 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
1029 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
1030 # long and match the regular expression
1031 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
1032 # first character must be a lowercase letter, and all following
1033 # characters must be a dash, period, underscore, lowercase letter, or
1034 # digit, except the last character, which cannot be a dash, period, or
1035 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
1036 # field can only be used for a global or regional backend service with the
1037 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
1038 },
1039 ],
1040 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
1041 # custom
1042 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
1043 &quot;A String&quot;,
1044 ],
1045 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
1046 # custom
1047 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
1048 &quot;A String&quot;,
1049 ],
1050 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1051 # create the resource.
1052 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
1053 # backend service with dynamic forwarding feature which together with Service
1054 # Extension allows customized and complex routing logic.
1055 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
1056 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
1057 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
1058 },
1059 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
1060 # service. Some ranges are restricted: Restricted
1061 # ranges.
1062 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
1063 },
1064 },
1065 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
1066 # this backend service.
1067 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
1068 # global external Application Load Balancer.
1069 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
1070 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
1071 #
1072 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
1073 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
1074 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
1075 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
1076 # externalManagedMigrationTestingPercentage.
1077 #
1078 # Rolling back a migration requires the states to be set in reverse order. So
1079 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
1080 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
1081 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
1082 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
1083 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
1084 # external Application Load Balancer.
1085 #
1086 # The value of this field must be in the range [0, 100].
1087 #
1088 # Session affinity options will slightly affect this routing behavior, for
1089 # more details, see:Session
1090 # Affinity.
1091 #
1092 # This value can only be set if the loadBalancingScheme in the BackendService
1093 # is set to EXTERNAL (when using the classic Application Load Balancer) and
1094 # the migration state is TEST_BY_PERCENTAGE.
1095 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
1096 # as a backup (failover) backend.
1097 # For load balancers that have configurable failover:
1098 # [Internal passthrough Network Load
1099 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1100 # and [external passthrough Network Load
1101 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1102 #
1103 # failoverPolicy cannot be specified with haPolicy.
1104 # failover:
1105 # [Internal passthrough Network Load
1106 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1107 # and [external passthrough
1108 # Network Load
1109 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1110 # On failover or failback, this field indicates whether connection draining
1111 # will be honored. Google Cloud has a fixed connection draining timeout of
1112 # 10 minutes. A setting of true terminates existing TCP
1113 # connections to the active pool during failover and failback, immediately
1114 # draining traffic. A setting of false allows existing TCP
1115 # connections to persist, even on VMs no longer in the active pool, for up
1116 # to the duration of the connection draining timeout (10 minutes).
1117 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
1118 #
1119 # The default is false.
1120 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
1121 # load balancer are dropped when all primary and all backup backend VMs are
1122 # unhealthy.If set to false, connections are distributed
1123 # among all primary VMs when all primary and all backup backend VMs are
1124 # unhealthy.
1125 # For load balancers that have configurable
1126 # failover:
1127 # [Internal passthrough
1128 # Network Load
1129 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1130 # and [external passthrough
1131 # Network Load
1132 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1133 # The default is false.
1134 &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
1135 # failover when the number of healthy primary VMs equals zero.
1136 # For all other values, the load balancer performs a failover when the
1137 # total number of healthy primary VMs is less than this ratio.
1138 # For load balancers that have configurable
1139 # failover:
1140 # [Internal TCP/UDP Load
1141 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1142 # and [external TCP/UDP Load
1143 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1144 },
1145 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1146 # This field is used in optimistic locking. This field will be ignored when
1147 # inserting a BackendService. An up-to-date fingerprint must be provided in
1148 # order to update the BackendService, otherwise the request will
1149 # fail with error 412 conditionNotMet.
1150 #
1151 # To see the latest fingerprint, make a get() request to
1152 # retrieve a BackendService.
1153 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
1154 # Protocol Forwarding.
1155 #
1156 # The backends of this regional backend service must only specify zonal
1157 # network endpoint groups (NEGs) of type GCE_VM_IP.
1158 #
1159 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
1160 # regional backend service must set the network field. All zonal NEGs must
1161 # belong to the same network. However, individual NEGs can
1162 # belong to different subnetworks of that network.
1163 #
1164 # When haPolicy is specified, the set of attached network endpoints across
1165 # all backends comprise an High Availability domain from which one endpoint
1166 # is selected as the active endpoint (the leader) that receives all
1167 # traffic.
1168 #
1169 # haPolicy can be added only at backend service creation time. Once set up,
1170 # it cannot be deleted.
1171 #
1172 # Note that haPolicy is not for load balancing, and therefore cannot be
1173 # specified with sessionAffinity, connectionTrackingPolicy, and
1174 # failoverPolicy.
1175 #
1176 # haPolicy requires customers to be responsible for tracking backend
1177 # endpoint health and electing a leader among the healthy endpoints.
1178 # Therefore, haPolicy cannot be specified with healthChecks.
1179 #
1180 # haPolicy can only be specified for External Passthrough Network Load
1181 # Balancers and Internal Passthrough Network Load Balancers.
1182 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
1183 # achieve it.
1184 #
1185 # Supported values are:
1186 #
1187 # - DISABLED: Fast IP Move is disabled. You can only use the
1188 # haPolicy.leader API to update the leader.
1189 # - &gt;GARP_RA: Provides a method to very quickly define a new network
1190 # endpoint as the leader. This method is faster than updating the leader
1191 # using the haPolicy.leader API. Fast IP move works as follows: The VM
1192 # hosting the network endpoint that should become the new leader sends
1193 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
1194 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
1195 # temporarily associates the forwarding rule IP address with that VM, and
1196 # both new and in-flight packets are quickly delivered to that VM.
1197 #
1198 #
1199 #
1200 # Note the important properties of the Fast IP Move functionality:
1201 #
1202 # - The GARP/RA-initiated re-routing stays active for approximately 20
1203 # minutes. After triggering fast failover, you must also
1204 # appropriately set the haPolicy.leader.
1205 # - The new leader instance should continue to send GARP/RA packets
1206 # periodically every 10 seconds until at least 10 minutes after updating
1207 # the haPolicy.leader (but stop immediately if it is no longer the leader).
1208 # - After triggering a fast failover, we recommend that you wait at least
1209 # 3 seconds before sending another GARP/RA packet from a different VM
1210 # instance to avoid race conditions.
1211 # - Don&#x27;t send GARP/RA packets from different VM
1212 # instances at the same time. If multiple instances continue to send
1213 # GARP/RA packets, traffic might be routed to different destinations in an
1214 # alternating order. This condition ceases when a single instance
1215 # issues a GARP/RA packet.
1216 # - The GARP/RA request always takes priority over the leader API.
1217 # Using the haPolicy.leader API to change the leader to a different
1218 # instance will have no effect until the GARP/RA request becomes
1219 # inactive.
1220 # - The GARP/RA packets should follow the GARP/RA
1221 # Packet Specifications..
1222 # - When multiple forwarding rules refer to a regional backend service,
1223 # you need only send a GARP or RA packet for a single forwarding rule
1224 # virtual IP. The virtual IPs for all forwarding rules targeting the same
1225 # backend service will also be moved to the sender of the GARP or RA
1226 # packet.
1227 #
1228 #
1229 #
1230 # The following are the Fast IP Move limitations (that is, when fastIPMove
1231 # is not DISABLED):
1232 #
1233 # - Multiple forwarding rules cannot use the same IP address if one of
1234 # them refers to a regional backend service with fastIPMove.
1235 # - The regional backend service must set the network field, and all
1236 # NEGs must belong to that network. However, individual
1237 # NEGs can belong to different subnetworks of that network.
1238 # - The maximum number of network endpoints across all backends of a
1239 # backend service with fastIPMove is 32.
1240 # - The maximum number of backend services with fastIPMove that can have
1241 # the same network endpoint attached to one of its backends is 64.
1242 # - The maximum number of backend services with fastIPMove in a VPC in a
1243 # region is 64.
1244 # - The network endpoints that are attached to a backend of a backend
1245 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
1246 # - Traffic directed to the leader by a static route next hop will not be
1247 # redirected to a new leader by fast failover. Such traffic will only be
1248 # redirected once an haPolicy.leader update has taken effect. Only traffic
1249 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
1250 # fast failover.
1251 #
1252 #
1253 # haPolicy.fastIPMove can be set only at backend service creation time.
1254 # Once set, it cannot be updated.
1255 #
1256 # By default, fastIpMove is set to DISABLED.
1257 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
1258 # this service as the active endpoint (the leader) that receives all
1259 # traffic.
1260 #
1261 # When the leader changes, there is no connection draining to persist
1262 # existing connections on the old leader.
1263 #
1264 # You are responsible for selecting a suitable endpoint as the
1265 # leader. For example, preferring a healthy endpoint over unhealthy ones.
1266 # Note that this service does not track backend endpoint health, and
1267 # selects the configured leader unconditionally.
1268 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
1269 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
1270 # that the leader is attached to.
1271 #
1272 # The leader&#x27;s backendGroup must already be specified as a backend of
1273 # this backend service. Removing a backend that is designated as the
1274 # leader&#x27;s backendGroup is not permitted.
1275 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
1276 # designated as the leader.
1277 #
1278 # This network endpoint cannot be detached from the NEG specified in
1279 # the haPolicy.leader.backendGroup until the leader is updated with
1280 # another network endpoint, or the leader is removed from the haPolicy.
1281 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
1282 # instance must already be attached to the NEG specified in the
1283 # haPolicy.leader.backendGroup.
1284 #
1285 # The name must be 1-63 characters long, and comply with RFC1035.
1286 # Authorization requires the following IAM permission on the
1287 # specified resource instance: compute.instances.use
1288 },
1289 },
1290 },
1291 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
1292 # httpsHealthChecks (legacy) resource for health checking this backend
1293 # service. Not all backend services support legacy health checks. See
1294 # Load balancer guide. Currently, at most one health check can be
1295 # specified for each backend service. Backend services with
1296 # instance group or zonal NEG backends must have a health check unless
1297 # haPolicy is specified. Backend services with internet or serverless NEG
1298 # backends must not have a health check.
1299 #
1300 # healthChecks[] cannot be specified with haPolicy.
1301 &quot;A String&quot;,
1302 ],
1303 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
1304 # Not available for internal passthrough Network Load Balancers and external
1305 # passthrough Network Load Balancers.
1306 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
1307 # incoming requests.
1308 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
1309 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
1310 # for IAP.
1311 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
1312 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
1313 # Optional - If not provided, the name will be autogenerated by the
1314 # backend.
1315 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
1316 },
1317 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
1318 # For security reasons, this value cannot be retrieved via the API.
1319 # Instead, the SHA-256 hash of the value is returned in the
1320 # oauth2ClientSecretSha256 field.
1321 #
1322 # @InputOnly
1323 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
1324 },
1325 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1326 # defined by the server.
1327 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
1328 # from the client to the backend for proxyless gRPC).
1329 # The possible values are:
1330 #
1331 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
1332 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1333 # Group), regardless of traffic from the client to the proxy. Only IPv4
1334 # health checks are used to check the health of the backends. This is the
1335 # default setting.
1336 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
1337 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
1338 # address).
1339 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
1340 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1341 # Group), regardless of traffic from the client to the proxy. Only IPv6
1342 # health checks are used to check the health of the backends.
1343 #
1344 #
1345 #
1346 # This field is applicable to either:
1347 #
1348 # - Advanced global external Application Load Balancer (load balancing
1349 # scheme EXTERNAL_MANAGED),
1350 # - Regional external Application Load
1351 # Balancer,
1352 # - Internal proxy Network Load Balancer (load balancing
1353 # scheme INTERNAL_MANAGED),
1354 # - Regional internal Application Load
1355 # Balancer (load balancing scheme INTERNAL_MANAGED),
1356 # - Traffic
1357 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
1358 # INTERNAL_SELF_MANAGED).
1359 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
1360 # for backend services.
1361 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
1362 # created for one type of load balancer cannot be used with another.
1363 # For more information, refer toChoosing
1364 # a load balancer.
1365 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
1366 # preference. When you use localityLbPolicies, you must set at least one
1367 # value for either the localityLbPolicies[].policy or the
1368 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
1369 # value set in the localityLbPolicy field.
1370 #
1371 # For an example of how to use this field, seeDefine
1372 # a list of preferred policies.
1373 #
1374 # Caution: This field and its children are intended for use in a service mesh
1375 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
1376 # that have this configuration.
1377 { # Container for either a built-in LB policy supported by gRPC or Envoy or
1378 # a custom one implemented by the end user.
1379 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
1380 # deployed with the client.
1381 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
1382 # by a locally installed custom policy implementation.
1383 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
1384 #
1385 # The value should match the name of a custom implementation registered
1386 # on the gRPC clients. It should follow protocol buffer message naming
1387 # conventions and include the full path (for example,
1388 # myorg.CustomLbPolicy). The maximum length is 256 characters.
1389 #
1390 # Do not specify the same custom policy more than once for a
1391 # backend. If you do, the configuration is rejected.
1392 #
1393 # For an example of how to use this field, seeUse
1394 # a custom policy.
1395 },
1396 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
1397 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
1398 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
1399 # about these values, see the description of localityLbPolicy.
1400 #
1401 # Do not specify the same policy more than once for a
1402 # backend. If you do, the configuration is rejected.
1403 },
1404 },
1405 ],
1406 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
1407 # possible values are:
1408 #
1409 # - ROUND_ROBIN: This is a simple policy in which each healthy
1410 # backend is selected in round robin order. This is the default.
1411 # - LEAST_REQUEST: An O(1) algorithm which
1412 # selects two random healthy hosts and picks the host which has fewer active
1413 # requests.
1414 # - RING_HASH: The ring/modulo hash load balancer implements
1415 # consistent hashing to backends. The algorithm has the property that the
1416 # addition/removal of a host from a set of N hosts only affects 1/N of the
1417 # requests.
1418 # - RANDOM: The load balancer selects a random healthy
1419 # host.
1420 # - ORIGINAL_DESTINATION: Backend host is selected
1421 # based on the client connection metadata, i.e., connections are opened to
1422 # the same address as the destination address of the incoming connection
1423 # before the connection was redirected to the load balancer.
1424 # - MAGLEV: used as a drop in replacement for the ring hash
1425 # load balancer. Maglev is not as stable as ring hash but has faster table
1426 # lookup build times and host selection times. For more information about
1427 # Maglev, see Maglev:
1428 # A Fast and Reliable Software Network Load Balancer.
1429 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
1430 # Load Balancing using weights computed from Backend reported Custom Metrics.
1431 # If set, the Backend Service responses are expected to contain non-standard
1432 # HTTP response header field Endpoint-Load-Metrics. The reported
1433 # metrics to use for computing the weights are specified via thecustomMetrics field.
1434 #
1435 # This field is applicable to either:
1436 # - A regional backend service with the service protocol set to HTTP,
1437 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
1438 # INTERNAL_MANAGED.
1439 # - A global backend service with the
1440 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
1441 # EXTERNAL_MANAGED.
1442 #
1443 #
1444 # If sessionAffinity is not configured—that is, if session
1445 # affinity remains at the default value of NONE—then the
1446 # default value for localityLbPolicy
1447 # is ROUND_ROBIN. If session affinity is set to a value other
1448 # than NONE,
1449 # then the default value for localityLbPolicy isMAGLEV.
1450 #
1451 # Only ROUND_ROBIN and RING_HASH are supported
1452 # when the backend service is referenced by a URL map that is bound to
1453 # target gRPC proxy that has validateForProxyless field set to true.
1454 #
1455 # localityLbPolicy cannot be specified with haPolicy.
1456 &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
1457 # by this backend service. If logging is enabled, logs will be exported to
1458 # Stackdriver.
1459 # backend service.
1460 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
1461 # traffic served by this backend service. The default value is false.
1462 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
1463 { # Determines which HTTP headers will be logged to Stackdriver.
1464 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1465 },
1466 ],
1467 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
1468 { # Determines which HTTP headers will be logged to Stackdriver.
1469 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1470 },
1471 ],
1472 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
1473 # This field can only be specified if logging is enabled for this backend
1474 # service. Configures whether all, none or a subset of optional fields
1475 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1476 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1477 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
1478 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
1479 # of optional fields you want to include in the logs. For example:
1480 # serverInstance, serverGkeDetails.cluster,
1481 # serverGkeDetails.pod.podNamespace
1482 &quot;A String&quot;,
1483 ],
1484 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
1485 # service. Configures whether all, none or a subset of optional fields
1486 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1487 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1488 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
1489 # service. The value of the field must be in [0, 1]. This configures the
1490 # sampling rate of requests to the load balancer where 1.0 means all logged
1491 # requests are reported and 0.0 means no logged requests are reported. The
1492 # default value is 1.0.
1493 },
1494 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
1495 # service. Duration is computed from the beginning of the stream until the
1496 # response has been completely processed, including all retries. A stream
1497 # that does not complete in this duration is closed.
1498 #
1499 # If not specified, there will be no timeout limit, i.e. the maximum
1500 # duration is infinite.
1501 #
1502 # This value can be overridden in the PathMatcher configuration of the
1503 # UrlMap that references this backend service.
1504 #
1505 # This field is only allowed when the loadBalancingScheme of
1506 # the backend service is INTERNAL_SELF_MANAGED.
1507 # as a count of seconds and fractions of seconds at nanosecond
1508 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1509 # or &quot;month&quot;. Range is approximately 10,000 years.
1510 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1511 # Durations less than one second are represented with a 0
1512 # `seconds` field and a positive `nanos` field. Must be from 0
1513 # to 999,999,999 inclusive.
1514 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1515 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1516 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1517 },
1518 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
1519 # controller and read by the backend RCTH
1520 &quot;a_key&quot;: &quot;A String&quot;,
1521 },
1522 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1523 # The name must be 1-63 characters long, and comply withRFC1035.
1524 # Specifically, the name must be 1-63 characters long and match the regular
1525 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1526 # character must be a lowercase letter, and all following characters must
1527 # be a dash, lowercase letter, or digit, except the last character, which
1528 # cannot be a dash.
1529 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
1530 #
1531 # This field must be set for Internal Passthrough Network Load Balancers when
1532 # the haPolicy is enabled, and for External Passthrough Network Load
1533 # Balancers when the haPolicy fastIpMove is enabled.
1534 #
1535 # 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.
1536 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
1537 # Load Balancers.
1538 #
1539 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
1540 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
1541 # endpoints in the local zone.
1542 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
1543 # possible values are:
1544 #
1545 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
1546 # is disabled. The load balancer distributes new connections to all
1547 # healthy backend endpoints across all zones.
1548 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
1549 # enabled. The load balancer distributes new connections to all healthy
1550 # backend endpoints in the local zone only. If there are no healthy
1551 # backend endpoints in the local zone, the load balancer distributes
1552 # new connections to all backend endpoints in the local zone.
1553 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
1554 # enabled. The load balancer distributes new connections to all healthy
1555 # backend endpoints in the local zone only. If there aren&#x27;t enough
1556 # healthy backend endpoints in the local zone, the load balancer
1557 # distributes new connections to all healthy backend endpoints across all
1558 # zones.
1559 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
1560 # of healthy backend endpoints in a zone to the count of backend
1561 # endpoints in that same zone is equal to or above this threshold, the
1562 # load balancer distributes new connections to all healthy endpoints in
1563 # the local zone only. When the ratio of the count of healthy backend
1564 # endpoints in a zone to the count of backend endpoints in that same
1565 # zone is below this threshold, the load balancer distributes all new
1566 # connections to all healthy endpoints across all zones.
1567 },
1568 },
1569 &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.
1570 # the backend service.
1571 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
1572 # service.
1573 },
1574 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
1575 # load balancing pool of each individual proxy instance that processes the
1576 # traffic for the given backend service. If not set, this feature is
1577 # considered disabled.
1578 #
1579 # Results of the outlier detection algorithm (ejection of endpoints from the
1580 # load balancing pool and returning them back to the pool) are executed
1581 # independently by each proxy instance of the load balancer. In most cases,
1582 # more than one proxy instance handles the traffic received by a backend
1583 # service. Thus, it is possible that an unhealthy endpoint is detected and
1584 # ejected by only some of the proxies, and while this happens, other proxies
1585 # may continue to send requests to the same unhealthy endpoint until they
1586 # detect and eject the unhealthy endpoint.
1587 #
1588 # Applicable backend endpoints can be:
1589 #
1590 # - VM instances in an Instance Group
1591 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
1592 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
1593 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
1594 # Functions Services
1595 # - Private Service Connect NEGs, that resolve to
1596 # Google-managed regional API endpoints or managed services published using
1597 # Private Service Connect
1598 #
1599 #
1600 #
1601 # Applicable backend service types can be:
1602 #
1603 # - A global backend service with the loadBalancingScheme set to
1604 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
1605 # - A regional backend
1606 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
1607 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
1608 # supported for Serverless NEGs.
1609 #
1610 #
1611 #
1612 # Not supported when the backend service is referenced by a URL map that is
1613 # bound to target gRPC proxy that has validateForProxyless field set to true.
1614 # pool for the backend service.
1615 &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
1616 # or 30s.
1617 #
1618 # After a backend endpoint is returned back to the load balancing pool, it
1619 # can be ejected again in another ejection analysis. Thus, the total ejection
1620 # time is equal to the base ejection time multiplied by the number of times
1621 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
1622 # as a count of seconds and fractions of seconds at nanosecond
1623 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1624 # or &quot;month&quot;. Range is approximately 10,000 years.
1625 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1626 # Durations less than one second are represented with a 0
1627 # `seconds` field and a positive `nanos` field. Must be from 0
1628 # to 999,999,999 inclusive.
1629 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1630 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1631 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1632 },
1633 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
1634 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
1635 # return code qualifies as an error. Defaults to 5.
1636 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
1637 # connection errors that are mapped to one of those status codes) before a
1638 # consecutive gateway failure ejection occurs. Defaults to 3.
1639 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1640 # outlier status is detected through consecutive 5xx. This setting can be
1641 # used to disable ejection or to ramp it up slowly. Defaults to 0.
1642 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1643 # outlier status is detected through consecutive gateway failures. This
1644 # setting can be used to disable ejection or to ramp it up slowly. Defaults
1645 # to 100.
1646 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1647 # outlier status is detected through success rate statistics. This setting
1648 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
1649 #
1650 # Not supported when the backend service uses Serverless NEG.
1651 &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
1652 # ejections and backend endpoints being returned to service. The interval is
1653 # equal to the number of seconds as defined in
1654 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
1655 # in outlierDetection.interval.nanos. Defaults to 1 second.
1656 # as a count of seconds and fractions of seconds at nanosecond
1657 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1658 # or &quot;month&quot;. Range is approximately 10,000 years.
1659 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1660 # Durations less than one second are represented with a 0
1661 # `seconds` field and a positive `nanos` field. Must be from 0
1662 # to 999,999,999 inclusive.
1663 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1664 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1665 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1666 },
1667 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
1668 # backend service that can be ejected if the ejection conditions are met.
1669 # Defaults to 50%.
1670 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
1671 # enough request volume to detect success rate outliers. If the number of
1672 # backend endpoints is fewer than this setting, outlier detection via success
1673 # rate statistics is not performed for any backend endpoint in the load
1674 # balancing pool. Defaults to 5.
1675 #
1676 # Not supported when the backend service uses Serverless NEG.
1677 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
1678 # (as defined by the interval duration above) to include this backend
1679 # endpoint in success rate based outlier detection. If the volume is lower
1680 # than this setting, outlier detection via success rate statistics is not
1681 # performed for that backend endpoint. Defaults to 100.
1682 #
1683 # Not supported when the backend service uses Serverless NEG.
1684 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
1685 # outlier ejection. The ejection threshold is the difference between the mean
1686 # success rate, and the product of this factor and the standard deviation of
1687 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
1688 # is divided by a thousand to get a double. That is, if the desired factor
1689 # is 1.9, the runtime value should be 1900. Defaults to 1900.
1690 #
1691 # Not supported when the backend service uses Serverless NEG.
1692 },
1693 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1694 # as part of resource payload.
1695 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1696 # Tag keys and values have the same definition as resource
1697 # manager tags. The field is allowed for INSERT
1698 # only. The keys/values to set on the resource should be specified in
1699 # either ID { : } or Namespaced format
1700 # { : }.
1701 # For example the following are valid inputs:
1702 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1703 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1704 # Note:
1705 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1706 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1707 &quot;a_key&quot;: &quot;A String&quot;,
1708 },
1709 },
1710 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
1711 # the backend. The default value is 80.
1712 # For internal passthrough Network Load Balancers and external passthrough
1713 # Network Load Balancers, omit port.
1714 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
1715 # communication to the backend VMs in that group. The
1716 # named port must be [defined on each backend instance
1717 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
1718 # This parameter has no meaning if the backends are NEGs. For internal
1719 # passthrough Network Load Balancers and external passthrough Network Load
1720 # Balancers, omit port_name.
1721 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
1722 # with backends.
1723 #
1724 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
1725 # depending on the chosen load balancer or Traffic Director configuration.
1726 # Refer to the documentation for the load balancers or for Traffic Director
1727 # for more information.
1728 #
1729 # Must be set to GRPC when the backend service is referenced by a URL map
1730 # that is bound to target gRPC proxy.
1731 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
1732 # resides. This field is not applicable to global backend services.
1733 # You must specify this field as part of the HTTP request URL. It is
1734 # not settable as a field in the request body.
1735 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1736 # backend service.
1737 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
1738 # service. This field is applicable to a global backend service with the
1739 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
1740 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
1741 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
1742 # be accepted on backends, and if authenticated, which method/certificate
1743 # will set the request principal.
1744 # request principal.
1745 # The authentication settings for the backend service.
1746 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
1747 # Similar to peers, these will be evaluated in order the first valid one
1748 # will be used to set origin identity. If none of these methods pass, the
1749 # request will be rejected with authentication failed error (401). Leave the
1750 # list empty if origin authentication is not required.
1751 { # [Deprecated] Configuration for the origin authentication method.
1752 # Configuration for the origin authentication method.
1753 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
1754 # JWT configuration for origin authentication.
1755 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
1756 # will be accepted if audiences is empty.
1757 # Examples: bookstore_android.apps.googleusercontent.com,
1758 # bookstore_web.apps.googleusercontent.com
1759 &quot;A String&quot;,
1760 ],
1761 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
1762 # email address.
1763 # Examples: https://securetoken.google.com,
1764 # [email protected]
1765 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
1766 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
1767 # request. If no explicit location is specified, the following default
1768 # locations are tried in order:
1769 #
1770 # 1. The Authorization header using the Bearer schema. See `here
1771 # `_. Example:
1772 #
1773 # Authorization: Bearer .
1774 #
1775 # 2. `access_token` query parameter. See `this
1776 # `_
1777 #
1778 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
1779 # from the locations its issuer specified or from the default locations.
1780 #
1781 # This field is set if JWT is sent in a request header. This field specifies
1782 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
1783 # header format will be x-goog-iap-jwt-assertion: .
1784 { # [Deprecated] This message specifies a header location to extract JWT token.
1785 # This message specifies a header location to extract JWT token.
1786 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
1787 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
1788 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
1789 # with a space at the end.
1790 },
1791 ],
1792 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
1793 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
1794 # JWT format in the query parameter is /path?jwt_token=.
1795 &quot;A String&quot;,
1796 ],
1797 },
1798 },
1799 ],
1800 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
1801 # They will be evaluated in order the first valid one will be used to set
1802 # peer identity. If none of these methods pass, the request will be rejected
1803 # with authentication failed error (401). Leave the list empty if peer
1804 # authentication is not required.
1805 { # [Deprecated] Configuration for the peer authentication method.
1806 # Configuration for the peer authentication method.
1807 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
1808 # Configuration for the mutual Tls mode for peer authentication.
1809 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
1810 # field can be set to one of the following:
1811 # STRICT: Client certificate must be presented, connection is in TLS.
1812 # PERMISSIVE: Client certificate can be omitted, connection can be either
1813 # plaintext or TLS.
1814 },
1815 },
1816 ],
1817 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
1818 # Default value is USE_PEER. If peer (or origin) identity is not available,
1819 # either because peer/origin authentication is not defined, or failed,
1820 # principal will be left unset. In other words, binding rule does not affect
1821 # the decision to accept or reject request. This field can be set to one of
1822 # the following:
1823 # USE_PEER: Principal will be set to the identity from peer authentication.
1824 # USE_ORIGIN: Principal will be set to the identity from origin
1825 # authentication.
1826 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
1827 # identity information.
1828 # The TLS settings for the client or server.
1829 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
1830 # certificate.
1831 # Defines the mechanism to obtain the client or server certificate.
1832 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
1833 # applicable only if tlsCertificateSource is set to USE_PATH.
1834 # The paths to the mounted TLS Certificates and private key.
1835 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1836 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1837 },
1838 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
1839 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
1840 # is applicable only if tlsCertificateSource is set to USE_SDS.
1841 # The configuration to access the SDS server.
1842 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
1843 # gRPC config to access the SDS server.
1844 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
1845 # gRPC call credentials to access the SDS server.
1846 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
1847 # This field can be set to one of the following:
1848 #
1849 # - GCE_VM: The local GCE VM service account credentials are used to access
1850 # the SDS server.
1851 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
1852 # SDS server.
1853 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
1854 # FROM_PLUGIN.
1855 # Custom authenticator credentials.
1856 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
1857 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
1858 # plugin.
1859 },
1860 },
1861 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
1862 # gRPC channel credentials to access the SDS server.
1863 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
1864 # The paths to the mounted TLS Certificates and private key.
1865 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1866 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1867 },
1868 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
1869 # to one of the following:
1870 # CERTIFICATES: Use TLS certificates to access the SDS server.
1871 # GCE_VM: Use local GCE VM credentials to access the SDS server.
1872 },
1873 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
1874 },
1875 },
1876 },
1877 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
1878 # validate the client/server certificate. If omitted, the proxy will not
1879 # validate the server or client certificate.
1880 # certificate to validate the client/server certificate.
1881 # validate the client/server certificate.
1882 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
1883 # client or server certificate.
1884 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
1885 # is applicable only if tlsCertificateSource is set to USE_SDS.
1886 # The configuration to access the SDS server.
1887 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
1888 # gRPC config to access the SDS server.
1889 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
1890 # gRPC call credentials to access the SDS server.
1891 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
1892 # This field can be set to one of the following:
1893 #
1894 # - GCE_VM: The local GCE VM service account credentials are used to access
1895 # the SDS server.
1896 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
1897 # SDS server.
1898 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
1899 # FROM_PLUGIN.
1900 # Custom authenticator credentials.
1901 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
1902 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
1903 # plugin.
1904 },
1905 },
1906 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
1907 # gRPC channel credentials to access the SDS server.
1908 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
1909 # The paths to the mounted TLS Certificates and private key.
1910 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
1911 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
1912 },
1913 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
1914 # to one of the following:
1915 # CERTIFICATES: Use TLS certificates to access the SDS server.
1916 # GCE_VM: Use local GCE VM credentials to access the SDS server.
1917 },
1918 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
1919 },
1920 },
1921 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
1922 },
1923 },
1924 },
1925 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
1926 # (RBAC) config.
1927 # Authorization config defines the Role Based Access Control (RBAC) config.
1928 # method-level access control for a service.
1929 # control for a service.
1930 &quot;policies&quot;: [ # List of RbacPolicies.
1931 {
1932 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
1933 &quot;permissions&quot;: [ # The list of permissions.
1934 { # [Deprecated] All fields defined in a permission are ANDed.
1935 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
1936 { # Custom constraint that specifies a key and a list of allowed values for
1937 # Istio attributes.
1938 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
1939 &quot;values&quot;: [ # A list of allowed values.
1940 &quot;A String&quot;,
1941 ],
1942 },
1943 ],
1944 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
1945 # applies to. Exact match, prefix match, and suffix match are supported.
1946 &quot;A String&quot;,
1947 ],
1948 &quot;methods&quot;: [ # HTTP method.
1949 &quot;A String&quot;,
1950 ],
1951 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
1952 &quot;A String&quot;,
1953 ],
1954 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
1955 &quot;A String&quot;,
1956 ],
1957 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
1958 &quot;A String&quot;,
1959 ],
1960 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
1961 &quot;A String&quot;,
1962 ],
1963 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
1964 # Exact match, prefix match, and suffix match are supported.
1965 &quot;A String&quot;,
1966 ],
1967 &quot;ports&quot;: [ # Port names or numbers.
1968 &quot;A String&quot;,
1969 ],
1970 },
1971 ],
1972 &quot;principals&quot;: [ # The list of principals.
1973 { # [Deprecated] All fields defined in a principal are ANDed.
1974 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
1975 &quot;groups&quot;: [ # The groups the principal belongs to.
1976 # Exact match, prefix match, and suffix match are supported.
1977 &quot;A String&quot;,
1978 ],
1979 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
1980 &quot;A String&quot;,
1981 ],
1982 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
1983 &quot;A String&quot;,
1984 ],
1985 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
1986 &quot;A String&quot;,
1987 ],
1988 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
1989 &quot;A String&quot;,
1990 ],
1991 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
1992 &quot;A String&quot;,
1993 ],
1994 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
1995 &quot;A String&quot;,
1996 ],
1997 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
1998 # suffix match are supported for values. For example,
1999 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
2000 &quot;a_key&quot;: &quot;A String&quot;,
2001 },
2002 &quot;users&quot;: [ # The user names/IDs or service accounts.
2003 # Exact match, prefix match, and suffix match are supported.
2004 &quot;A String&quot;,
2005 ],
2006 },
2007 ],
2008 },
2009 ],
2010 },
2011 &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
2012 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
2013 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
2014 # private storage buckets that support Signature Version 4 for authentication.
2015 # The service name for generating the authentication header will always default
2016 # to &#x27;s3&#x27;.
2017 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
2018 # creating a backend that uses AWS v4 signature authentication, but will not
2019 # be returned as part of the configuration when queried with a REST API GET
2020 # request.
2021 #
2022 # @InputOnly
2023 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
2024 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
2025 # keep track of different iterations of your access key.
2026 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
2027 # the name of the region your cloud uses to host your origin. For example,
2028 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
2029 },
2030 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
2031 # that describes how clients should authenticate with this service&#x27;s
2032 # backends.
2033 #
2034 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
2035 # to INTERNAL_SELF_MANAGED.
2036 #
2037 # If left blank, communications are not encrypted.
2038 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
2039 # originating from the backend service.
2040 # the backend service.
2041 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
2042 # identity information. This field is only applicable when mode is set to
2043 # MUTUAL.
2044 # The TLS settings for the client or server.
2045 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
2046 # certificate.
2047 # Defines the mechanism to obtain the client or server certificate.
2048 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
2049 # applicable only if tlsCertificateSource is set to USE_PATH.
2050 # The paths to the mounted TLS Certificates and private key.
2051 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
2052 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
2053 },
2054 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
2055 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
2056 # is applicable only if tlsCertificateSource is set to USE_SDS.
2057 # The configuration to access the SDS server.
2058 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
2059 # gRPC config to access the SDS server.
2060 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
2061 # gRPC call credentials to access the SDS server.
2062 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
2063 # This field can be set to one of the following:
2064 #
2065 # - GCE_VM: The local GCE VM service account credentials are used to access
2066 # the SDS server.
2067 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
2068 # SDS server.
2069 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
2070 # FROM_PLUGIN.
2071 # Custom authenticator credentials.
2072 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
2073 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
2074 # plugin.
2075 },
2076 },
2077 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
2078 # gRPC channel credentials to access the SDS server.
2079 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
2080 # The paths to the mounted TLS Certificates and private key.
2081 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
2082 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
2083 },
2084 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
2085 # to one of the following:
2086 # CERTIFICATES: Use TLS certificates to access the SDS server.
2087 # GCE_VM: Use local GCE VM credentials to access the SDS server.
2088 },
2089 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
2090 },
2091 },
2092 },
2093 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
2094 # validate the client/server certificate. If omitted, the proxy will not
2095 # validate the server or client certificate.
2096 # certificate to validate the client/server certificate.
2097 # validate the client/server certificate.
2098 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
2099 # client or server certificate.
2100 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
2101 # is applicable only if tlsCertificateSource is set to USE_SDS.
2102 # The configuration to access the SDS server.
2103 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
2104 # gRPC config to access the SDS server.
2105 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
2106 # gRPC call credentials to access the SDS server.
2107 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
2108 # This field can be set to one of the following:
2109 #
2110 # - GCE_VM: The local GCE VM service account credentials are used to access
2111 # the SDS server.
2112 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
2113 # SDS server.
2114 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
2115 # FROM_PLUGIN.
2116 # Custom authenticator credentials.
2117 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
2118 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
2119 # plugin.
2120 },
2121 },
2122 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
2123 # gRPC channel credentials to access the SDS server.
2124 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
2125 # The paths to the mounted TLS Certificates and private key.
2126 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
2127 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
2128 },
2129 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
2130 # to one of the following:
2131 # CERTIFICATES: Use TLS certificates to access the SDS server.
2132 # GCE_VM: Use local GCE VM credentials to access the SDS server.
2133 },
2134 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
2135 },
2136 },
2137 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
2138 },
2139 },
2140 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
2141 # The value of this field determines how TLS is enforced. This can be set
2142 # to one of the following values: DISABLE: Do not setup a TLS connection to
2143 # the backends.
2144 # SIMPLE: Originate a TLS connection to the backends.
2145 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
2146 # client certificates for authentication.
2147 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
2148 # applicable only when mode is SIMPLE or MUTUAL.
2149 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
2150 # certificate.If specified,
2151 # the proxy will verify that the server certificate&#x27;s subject alt name
2152 # matches one of the specified values. This field is applicable only when
2153 # mode is SIMPLE or MUTUAL.
2154 &quot;A String&quot;,
2155 ],
2156 },
2157 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
2158 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
2159 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
2160 # specified values, the communication continues. Otherwise, it fails. This
2161 # additional check enables the client to verify that the server is authorized
2162 # to run the requested service.
2163 #
2164 # Note that the contents of the server
2165 # certificate&#x27;s subjectAltName field are configured by the
2166 # Public Key Infrastructure which provisions server identities.
2167 #
2168 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
2169 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
2170 # mode).
2171 &quot;A String&quot;,
2172 ],
2173 },
2174 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2175 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2176 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
2177 #
2178 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
2179 # If set, lists of backends and health checks must be both empty.
2180 &quot;A String&quot;,
2181 ],
2182 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
2183 #
2184 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
2185 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
2186 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
2187 #
2188 # Only NONE and HEADER_FIELD are supported
2189 # when the backend service is referenced by a URL map that is bound to
2190 # target gRPC proxy that has validateForProxyless field set to true.
2191 #
2192 # For more details, see:
2193 # [Session
2194 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
2195 #
2196 # sessionAffinity cannot be specified with haPolicy.
2197 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
2198 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
2199 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
2200 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
2201 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
2202 # as a count of seconds and fractions of seconds at nanosecond
2203 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2204 # or &quot;month&quot;. Range is approximately 10,000 years.
2205 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2206 # Durations less than one second are represented with a 0
2207 # `seconds` field and a positive `nanos` field. Must be from 0
2208 # to 999,999,999 inclusive.
2209 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2210 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2211 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2212 },
2213 },
2214 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
2215 # Currently this is applicable only for Internal TCP/UDP load balancing,
2216 # Internal HTTP(S) load balancing and Traffic Director.
2217 &quot;policy&quot;: &quot;A String&quot;,
2218 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
2219 # each service mesh client.
2220 #
2221 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
2222 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
2223 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
2224 # `INTERNAL_SELF_MANAGED`.
2225 #
2226 # `subset_size` is optional for Internal HTTP(S) load balancing
2227 # and required for Traffic Director.
2228 #
2229 # If you do not provide this value, Cloud Load Balancing will calculate it
2230 # dynamically to optimize the number of proxies/clients visible to each
2231 # backend and vice versa.
2232 #
2233 # Must be greater than 0. If `subset_size` is larger than the number of
2234 # backends/endpoints, then subsetting is disabled.
2235 },
2236 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
2237 # type of load balancer. For more information see,
2238 # Backend service settings.
2239 # The default is 30 seconds.
2240 # The full range of timeout values allowed goes from 1
2241 # through 2,147,483,647 seconds.
2242 #
2243 # This value can be overridden in the PathMatcher configuration of the
2244 # UrlMap that references this backend service.
2245 #
2246 # Not supported when the backend service is referenced by a URL map that is
2247 # bound to target gRPC proxy that has validateForProxyless field set to true.
2248 # Instead, use maxStreamDuration.
2249 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
2250 # when the backend protocol is SSL, HTTPS or HTTP2.
2251 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
2252 # networksecurity.googleapis.com namespace. Can be used in authenticating
2253 # TLS connections to the backend, as specified by the authenticationMode
2254 # field. Can only be specified if authenticationMode is not NONE.
2255 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
2256 #
2257 #
2258 # Use this property to configure the load balancer back-end to use
2259 # certificates and roots of trust provisioned by the Managed Workload
2260 # Identity system.
2261 #
2262 # The `identity` property is the
2263 # fully-specified SPIFFE ID to use in the SVID presented by the Load
2264 # Balancer Workload.
2265 #
2266 # The SPIFFE ID must be a resource starting with the
2267 # `trustDomain` property value, followed by the path to the Managed
2268 # Workload Identity.
2269 #
2270 # Supported SPIFFE ID format:
2271 #
2272 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
2273 #
2274 #
2275 # The Trust Domain within the Managed Identity must refer to a valid
2276 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
2277 # will be inherited from the Workload Identity Pool.
2278 #
2279 # Restrictions:
2280 #
2281 # - If you set the `identity` property, you cannot manually set
2282 # the following fields:
2283 # - tlsSettings.sni
2284 # - tlsSettings.subjectAltNames
2285 # - tlsSettings.authenticationConfig
2286 #
2287 #
2288 # When defining a `identity` for a RegionBackendServices, the
2289 # corresponding Workload Identity Pool must have a ca_pool
2290 # configured in the same region.
2291 #
2292 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
2293 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
2294 # balancer sends this string as the SNI hostname in the TLS connection to
2295 # the backend, and requires that this string match a Subject Alternative
2296 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
2297 # NEG backend, if the SNI is specified here, the load balancer uses it
2298 # regardless of whether the Regional Internet NEG is specified with FQDN or
2299 # IP address and port. When both sni and subjectAltNames[] are specified,
2300 # the load balancer matches the backend certificate&#x27;s SAN only to
2301 # subjectAltNames[].
2302 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
2303 # verifies during a TLS handshake with the backend. When the server
2304 # presents its X.509 certificate to the Load Balancer, the Load Balancer
2305 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
2306 # match one of the subjectAltNames in the list. This field is limited to 5
2307 # entries. When both sni and subjectAltNames[] are specified, the load
2308 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
2309 { # A Subject Alternative Name that the load balancer matches against the SAN
2310 # field in the TLS certificate provided by the backend, specified as either
2311 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
2312 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
2313 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
2314 },
2315 ],
2316 },
2317 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
2318 {
2319 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
2320 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
2321 # and ForwardingRule.
2322 },
2323 ],
2324 },
2325 ],
2326 &quot;warning&quot;: { # Informational warning which replaces the list of
2327 # backend services when the list is empty.
2328 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2329 # Engine returns NO_RESULTS_ON_PAGE if there
2330 # are no results in the response.
2331 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2332 # value format. For example:
2333 #
2334 # &quot;data&quot;: [
2335 # {
2336 # &quot;key&quot;: &quot;scope&quot;,
2337 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2338 # }
2339 {
2340 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2341 # returned. For example, for warnings where there are no results in a list
2342 # request for a particular zone, this key might be scope and
2343 # the key value might be the zone name. Other examples might be a key
2344 # indicating a deprecated resource and a suggested replacement, or a
2345 # warning about invalid network settings (for example, if an instance
2346 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2347 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2348 },
2349 ],
2350 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2351 },
2352 },
2353 },
2354 &quot;kind&quot;: &quot;compute#backendServiceAggregatedList&quot;, # Output only. Type of resource.
2355 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2356 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2357 # the query parameter pageToken in the next list request.
2358 # Subsequent list requests will have their own nextPageToken to
2359 # continue paging through the results.
2360 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2361 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
2362 &quot;A String&quot;,
2363 ],
2364 &quot;warning&quot;: { # [Output Only] Informational warning message.
2365 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2366 # Engine returns NO_RESULTS_ON_PAGE if there
2367 # are no results in the response.
2368 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2369 # value format. For example:
2370 #
2371 # &quot;data&quot;: [
2372 # {
2373 # &quot;key&quot;: &quot;scope&quot;,
2374 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2375 # }
2376 {
2377 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2378 # returned. For example, for warnings where there are no results in a list
2379 # request for a particular zone, this key might be scope and
2380 # the key value might be the zone name. Other examples might be a key
2381 # indicating a deprecated resource and a suggested replacement, or a
2382 # warning about invalid network settings (for example, if an instance
2383 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2384 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2385 },
2386 ],
2387 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2388 },
2389 }</pre>
2390 </div>
2391
2392 <div class="method">
2393 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
2394 <pre>Retrieves the next page of results.
2395
2396 Args:
2397 previous_request: The request for the previous page. (required)
2398 previous_response: The response from the request for the previous page. (required)
2399
2400 Returns:
2401 A request object that you can call &#x27;execute()&#x27; on to request the next
2402 page. Returns None if there are no more items in the collection.
2403 </pre>
2404 </div>
2405
2406 <div class="method">
2407 <code class="details" id="close">close()</code>
2408 <pre>Close httplib2 connections.</pre>
2409 </div>
2410
2411 <div class="method">
2412 <code class="details" id="delete">delete(project, backendService, requestId=None, x__xgafv=None)</code>
2413 <pre>Deletes the specified BackendService resource.
2414
2415 Args:
2416 project: string, Project ID for this request. (required)
2417 backendService: string, Name of the BackendService resource to delete. (required)
2418 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2419 that if you must retry your request, the server will know to ignore the
2420 request if it has already been completed.
2421
2422 For example, consider a situation where you make an initial request and
2423 the request times out. If you make the request again with the same
2424 request ID, the server can check if original operation with the same
2425 request ID was received, and if so, will ignore the second request. This
2426 prevents clients from accidentally creating duplicate commitments.
2427
2428 The request ID must be
2429 a valid UUID with the exception that zero UUID is not supported
2430 (00000000-0000-0000-0000-000000000000).
2431 x__xgafv: string, V1 error format.
2432 Allowed values
2433 1 - v1 error format
2434 2 - v2 error format
2435
2436 Returns:
2437 An object of the form:
2438
2439 { # Represents an Operation resource.
2440 #
2441 # Google Compute Engine has three Operation resources:
2442 #
2443 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2444 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2445 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2446 #
2447 # You can use an operation resource to manage asynchronous API requests.
2448 # For more information, readHandling
2449 # API responses.
2450 #
2451 # Operations can be global, regional or zonal.
2452 #
2453 # - For global operations, use the `globalOperations`
2454 # resource.
2455 # - For regional operations, use the
2456 # `regionOperations` resource.
2457 # - For zonal operations, use
2458 # the `zoneOperations` resource.
2459 #
2460 #
2461 #
2462 # For more information, read
2463 # Global, Regional, and Zonal Resources.
2464 #
2465 # Note that completed Operation resources have a limited
2466 # retention period.
2467 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2468 # Not present otherwise.
2469 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2470 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2471 # set when the operation is created.
2472 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2473 # text format.
2474 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2475 # this field will be populated.
2476 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2477 # operation.
2478 {
2479 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2480 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2481 # details. There is a set of defined message types to use for providing
2482 # details.The syntax depends on the error code. For example,
2483 # QuotaExceededInfo will have details when the error code is
2484 # QUOTA_EXCEEDED.
2485 {
2486 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2487 #
2488 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2489 # is not enabled:
2490 #
2491 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2492 # &quot;domain&quot;: &quot;googleapis.com&quot;
2493 # &quot;metadata&quot;: {
2494 # &quot;resource&quot;: &quot;projects/123&quot;,
2495 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2496 # }
2497 # }
2498 #
2499 # This response indicates that the pubsub.googleapis.com API is not enabled.
2500 #
2501 # Example of an error that is returned when attempting to create a Spanner
2502 # instance in a region that is out of stock:
2503 #
2504 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2505 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2506 # &quot;metadata&quot;: {
2507 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2508 # }
2509 # }
2510 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2511 # is typically the registered service name of the tool or product that
2512 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2513 # generated by some common infrastructure, the error domain must be a
2514 # globally unique value that identifies the infrastructure. For Google API
2515 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2516 &quot;metadatas&quot;: { # Additional structured details about this error.
2517 #
2518 # Keys must match a regular expression of `a-z+` but should
2519 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2520 # length. When identifying the current value of an exceeded limit, the units
2521 # should be contained in the key, not the value. For example, rather than
2522 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2523 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2524 # instances that can be created in a single (batch) request.
2525 &quot;a_key&quot;: &quot;A String&quot;,
2526 },
2527 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2528 # proximate cause of the error. Error reasons are unique within a particular
2529 # domain of errors. This should be at most 63 characters and match a
2530 # regular expression of `A-Z+[A-Z0-9]`, which represents
2531 # UPPER_SNAKE_CASE.
2532 },
2533 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2534 #
2535 # For example, if a quota check failed with an error indicating the calling
2536 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2537 # directly to the right place in the developer console to flip the bit.
2538 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2539 { # Describes a URL link.
2540 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2541 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2542 },
2543 ],
2544 },
2545 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2546 # which can be attached to an RPC error.
2547 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2548 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2549 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2550 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2551 },
2552 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2553 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2554 &quot;a_key&quot;: &quot;A String&quot;,
2555 },
2556 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2557 # type or metric.
2558 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2559 # or metric.
2560 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2561 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2562 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2563 },
2564 },
2565 ],
2566 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2567 # This property is optional.
2568 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2569 },
2570 ],
2571 },
2572 &quot;getVersionOperationMetadata&quot;: {
2573 &quot;inlineSbomInfo&quot;: {
2574 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2575 # appropriate identifiers.
2576 &quot;a_key&quot;: &quot;A String&quot;,
2577 },
2578 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2579 # identifiers.
2580 &quot;a_key&quot;: &quot;A String&quot;,
2581 },
2582 },
2583 },
2584 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2585 # message that was returned, such as `NOT FOUND`.
2586 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2587 # status code that was returned. For example, a `404` means the
2588 # resource was not found.
2589 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2590 # defined by the server.
2591 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2592 # This value is inRFC3339
2593 # text format.
2594 &quot;instancesBulkInsertOperationMetadata&quot;: {
2595 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2596 # Example key: zones/us-central1-a
2597 &quot;a_key&quot;: {
2598 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2599 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2600 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2601 # error.
2602 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2603 # if the flow is rolling forward or rolling back.
2604 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2605 },
2606 },
2607 },
2608 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2609 # Operation resources.
2610 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2611 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2612 # group of operations results from a `bulkInsert` API request.
2613 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2614 # `update`, or `delete`, and so on.
2615 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2616 # There is no requirement that this be linear or support any granularity of
2617 # operations. This should not be used to guess when the operation will be
2618 # complete. This number should monotonically increase as the operation
2619 # progresses.
2620 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2621 # applicable when performing regional operations.
2622 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2623 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2624 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2625 # this field will contain information on all underlying zonal actions and
2626 # their state.
2627 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2628 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2629 # Example key: zones/us-central1-a
2630 &quot;a_key&quot;: {
2631 &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
2632 # populated.
2633 # different programming environments, including REST APIs and RPC APIs. It is
2634 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2635 # three pieces of data: error code, error message, and error details.
2636 #
2637 # You can find out more about this error model and how to work with it in the
2638 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2639 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2640 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2641 # message types for APIs to use.
2642 {
2643 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2644 },
2645 ],
2646 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2647 # user-facing error message should be localized and sent in the
2648 # google.rpc.Status.details field, or localized by the client.
2649 },
2650 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2651 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2652 },
2653 },
2654 },
2655 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2656 # This value is inRFC3339
2657 # text format.
2658 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2659 # following:
2660 # `PENDING`, `RUNNING`, or `DONE`.
2661 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2662 # operation.
2663 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2664 # of the target resource.
2665 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2666 # operations related to creating a snapshot, this points to the disk
2667 # that the snapshot was created from.
2668 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2669 # `[email protected]` or
2670 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2671 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2672 # operation, this field will be populated.
2673 {
2674 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2675 # Engine returns NO_RESULTS_ON_PAGE if there
2676 # are no results in the response.
2677 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2678 # value format. For example:
2679 #
2680 # &quot;data&quot;: [
2681 # {
2682 # &quot;key&quot;: &quot;scope&quot;,
2683 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2684 # }
2685 {
2686 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2687 # returned. For example, for warnings where there are no results in a list
2688 # request for a particular zone, this key might be scope and
2689 # the key value might be the zone name. Other examples might be a key
2690 # indicating a deprecated resource and a suggested replacement, or a
2691 # warning about invalid network settings (for example, if an instance
2692 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2693 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2694 },
2695 ],
2696 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2697 },
2698 ],
2699 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2700 # applicable when performing per-zone operations.
2701 }</pre>
2702 </div>
2703
2704 <div class="method">
2705 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None, x__xgafv=None)</code>
2706 <pre>Deletes a key for validating requests with signed URLs for this backend
2707 service.
2708
2709 Args:
2710 project: string, Project ID for this request. (required)
2711 backendService: string, Name of the BackendService resource to which the Signed URL Key should be
2712 added. The name should conform to RFC1035. (required)
2713 keyName: string, The name of the Signed URL Key to delete. (required)
2714 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2715 that if you must retry your request, the server will know to ignore the
2716 request if it has already been completed.
2717
2718 For example, consider a situation where you make an initial request and
2719 the request times out. If you make the request again with the same
2720 request ID, the server can check if original operation with the same
2721 request ID was received, and if so, will ignore the second request. This
2722 prevents clients from accidentally creating duplicate commitments.
2723
2724 The request ID must be
2725 a valid UUID with the exception that zero UUID is not supported
2726 (00000000-0000-0000-0000-000000000000).
2727 x__xgafv: string, V1 error format.
2728 Allowed values
2729 1 - v1 error format
2730 2 - v2 error format
2731
2732 Returns:
2733 An object of the form:
2734
2735 { # Represents an Operation resource.
2736 #
2737 # Google Compute Engine has three Operation resources:
2738 #
2739 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2740 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2741 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2742 #
2743 # You can use an operation resource to manage asynchronous API requests.
2744 # For more information, readHandling
2745 # API responses.
2746 #
2747 # Operations can be global, regional or zonal.
2748 #
2749 # - For global operations, use the `globalOperations`
2750 # resource.
2751 # - For regional operations, use the
2752 # `regionOperations` resource.
2753 # - For zonal operations, use
2754 # the `zoneOperations` resource.
2755 #
2756 #
2757 #
2758 # For more information, read
2759 # Global, Regional, and Zonal Resources.
2760 #
2761 # Note that completed Operation resources have a limited
2762 # retention period.
2763 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2764 # Not present otherwise.
2765 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2766 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2767 # set when the operation is created.
2768 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2769 # text format.
2770 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2771 # this field will be populated.
2772 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2773 # operation.
2774 {
2775 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2776 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2777 # details. There is a set of defined message types to use for providing
2778 # details.The syntax depends on the error code. For example,
2779 # QuotaExceededInfo will have details when the error code is
2780 # QUOTA_EXCEEDED.
2781 {
2782 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2783 #
2784 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2785 # is not enabled:
2786 #
2787 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2788 # &quot;domain&quot;: &quot;googleapis.com&quot;
2789 # &quot;metadata&quot;: {
2790 # &quot;resource&quot;: &quot;projects/123&quot;,
2791 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2792 # }
2793 # }
2794 #
2795 # This response indicates that the pubsub.googleapis.com API is not enabled.
2796 #
2797 # Example of an error that is returned when attempting to create a Spanner
2798 # instance in a region that is out of stock:
2799 #
2800 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2801 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2802 # &quot;metadata&quot;: {
2803 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2804 # }
2805 # }
2806 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2807 # is typically the registered service name of the tool or product that
2808 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2809 # generated by some common infrastructure, the error domain must be a
2810 # globally unique value that identifies the infrastructure. For Google API
2811 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2812 &quot;metadatas&quot;: { # Additional structured details about this error.
2813 #
2814 # Keys must match a regular expression of `a-z+` but should
2815 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2816 # length. When identifying the current value of an exceeded limit, the units
2817 # should be contained in the key, not the value. For example, rather than
2818 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2819 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2820 # instances that can be created in a single (batch) request.
2821 &quot;a_key&quot;: &quot;A String&quot;,
2822 },
2823 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2824 # proximate cause of the error. Error reasons are unique within a particular
2825 # domain of errors. This should be at most 63 characters and match a
2826 # regular expression of `A-Z+[A-Z0-9]`, which represents
2827 # UPPER_SNAKE_CASE.
2828 },
2829 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2830 #
2831 # For example, if a quota check failed with an error indicating the calling
2832 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2833 # directly to the right place in the developer console to flip the bit.
2834 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2835 { # Describes a URL link.
2836 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2837 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2838 },
2839 ],
2840 },
2841 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2842 # which can be attached to an RPC error.
2843 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2844 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2845 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2846 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2847 },
2848 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2849 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2850 &quot;a_key&quot;: &quot;A String&quot;,
2851 },
2852 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2853 # type or metric.
2854 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2855 # or metric.
2856 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2857 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2858 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2859 },
2860 },
2861 ],
2862 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2863 # This property is optional.
2864 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2865 },
2866 ],
2867 },
2868 &quot;getVersionOperationMetadata&quot;: {
2869 &quot;inlineSbomInfo&quot;: {
2870 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2871 # appropriate identifiers.
2872 &quot;a_key&quot;: &quot;A String&quot;,
2873 },
2874 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2875 # identifiers.
2876 &quot;a_key&quot;: &quot;A String&quot;,
2877 },
2878 },
2879 },
2880 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2881 # message that was returned, such as `NOT FOUND`.
2882 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2883 # status code that was returned. For example, a `404` means the
2884 # resource was not found.
2885 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2886 # defined by the server.
2887 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2888 # This value is inRFC3339
2889 # text format.
2890 &quot;instancesBulkInsertOperationMetadata&quot;: {
2891 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2892 # Example key: zones/us-central1-a
2893 &quot;a_key&quot;: {
2894 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2895 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2896 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2897 # error.
2898 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2899 # if the flow is rolling forward or rolling back.
2900 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2901 },
2902 },
2903 },
2904 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2905 # Operation resources.
2906 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2907 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2908 # group of operations results from a `bulkInsert` API request.
2909 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2910 # `update`, or `delete`, and so on.
2911 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2912 # There is no requirement that this be linear or support any granularity of
2913 # operations. This should not be used to guess when the operation will be
2914 # complete. This number should monotonically increase as the operation
2915 # progresses.
2916 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2917 # applicable when performing regional operations.
2918 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2919 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2920 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2921 # this field will contain information on all underlying zonal actions and
2922 # their state.
2923 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2924 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2925 # Example key: zones/us-central1-a
2926 &quot;a_key&quot;: {
2927 &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
2928 # populated.
2929 # different programming environments, including REST APIs and RPC APIs. It is
2930 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2931 # three pieces of data: error code, error message, and error details.
2932 #
2933 # You can find out more about this error model and how to work with it in the
2934 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2935 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2936 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2937 # message types for APIs to use.
2938 {
2939 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2940 },
2941 ],
2942 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2943 # user-facing error message should be localized and sent in the
2944 # google.rpc.Status.details field, or localized by the client.
2945 },
2946 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2947 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2948 },
2949 },
2950 },
2951 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2952 # This value is inRFC3339
2953 # text format.
2954 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2955 # following:
2956 # `PENDING`, `RUNNING`, or `DONE`.
2957 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2958 # operation.
2959 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2960 # of the target resource.
2961 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2962 # operations related to creating a snapshot, this points to the disk
2963 # that the snapshot was created from.
2964 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2965 # `[email protected]` or
2966 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2967 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2968 # operation, this field will be populated.
2969 {
2970 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2971 # Engine returns NO_RESULTS_ON_PAGE if there
2972 # are no results in the response.
2973 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2974 # value format. For example:
2975 #
2976 # &quot;data&quot;: [
2977 # {
2978 # &quot;key&quot;: &quot;scope&quot;,
2979 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2980 # }
2981 {
2982 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2983 # returned. For example, for warnings where there are no results in a list
2984 # request for a particular zone, this key might be scope and
2985 # the key value might be the zone name. Other examples might be a key
2986 # indicating a deprecated resource and a suggested replacement, or a
2987 # warning about invalid network settings (for example, if an instance
2988 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2989 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2990 },
2991 ],
2992 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2993 },
2994 ],
2995 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2996 # applicable when performing per-zone operations.
2997 }</pre>
2998 </div>
2999
3000 <div class="method">
3001 <code class="details" id="get">get(project, backendService, x__xgafv=None)</code>
3002 <pre>Returns the specified BackendService resource.
3003
3004 Args:
3005 project: string, Project ID for this request. (required)
3006 backendService: string, Name of the BackendService resource to return. (required)
3007 x__xgafv: string, V1 error format.
3008 Allowed values
3009 1 - v1 error format
3010 2 - v2 error format
3011
3012 Returns:
3013 An object of the form:
3014
3015 { # Represents a Backend Service resource.
3016 #
3017 # A backend service defines how Google Cloud load balancers distribute traffic.
3018 # The backend service configuration contains a set of values, such as the
3019 # protocol used to connect to backends, various distribution and session
3020 # settings, health checks, and timeouts. These settings provide fine-grained
3021 # control over how your load balancer behaves. Most of the settings have
3022 # default values that allow for easy configuration if you need to get started
3023 # quickly.
3024 #
3025 # Backend services in Google Compute Engine can be either regionally or
3026 # globally scoped.
3027 #
3028 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
3029 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
3030 #
3031 # For more information, seeBackend
3032 # Services.
3033 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
3034 # Load Balancers and Traffic Director and requires
3035 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
3036 #
3037 # If set to 0, the cookie is non-persistent and lasts only until
3038 # the end of the browser session (or equivalent). The maximum allowed value
3039 # is two weeks (1,209,600).
3040 #
3041 # Not supported when the backend service is referenced by a URL map that is
3042 # bound to target gRPC proxy that has validateForProxyless field set to true.
3043 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
3044 # load balancing scheme set to INTERNAL_SELF_MANAGED.
3045 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
3046 { # Message containing information of one individual backend.
3047 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
3048 # handle additional traffic or is fully loaded. For usage guidelines, see
3049 # Connection balancing mode.
3050 #
3051 # Backends must use compatible balancing modes. For more information, see
3052 # Supported balancing modes and target capacity settings and
3053 # Restrictions and guidance for instance groups.
3054 #
3055 # Note: Currently, if you use the API to configure incompatible balancing
3056 # modes, the configuration might be accepted even though it has no impact
3057 # and is ignored. Specifically, Backend.maxUtilization is ignored when
3058 # Backend.balancingMode is RATE. In the future, this incompatible combination
3059 # will be rejected.
3060 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
3061 # mode.
3062 # The default value is 1, which means the group serves up to
3063 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
3064 # completely drained, offering 0% of its available capacity. The valid ranges
3065 # are 0.0 and [0.1,1.0].
3066 # You cannot configure a setting larger than 0 and smaller than0.1.
3067 # You cannot configure a setting of 0 when there is only one
3068 # backend attached to the backend service.
3069 #
3070 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
3071 # internet NEGs, regional serverless NEGs, and PSC NEGs.
3072 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
3073 # BalancingMode.
3074 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
3075 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
3076 # Monitoring, but is not used for load balancing.
3077 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
3078 # balancing mode. The valid range is [0.0, 1.0].
3079 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
3080 # long and match the regular expression
3081 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
3082 # first character must be a lowercase letter, and all following
3083 # characters must be a dash, period, underscore, lowercase letter, or
3084 # digit, except the last character, which cannot be a dash, period, or
3085 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
3086 # field can only be used for a global or regional backend service with the
3087 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
3088 },
3089 ],
3090 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3091 # create the resource.
3092 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
3093 # failover backend can be configured for a given BackendService.
3094 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
3095 # group or network endpoint
3096 # group (NEG) resource. To determine what types of backends a load
3097 # balancer supports, see the [Backend services
3098 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
3099 #
3100 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
3101 # or NEG. Partial URLs are not supported.
3102 #
3103 # If haPolicy is specified, backends must refer to NEG resources of type
3104 # GCE_VM_IP.
3105 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
3106 # guidelines, seeConnection
3107 # balancing mode and Utilization
3108 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
3109 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
3110 # guidelines, seeConnection
3111 # balancing mode and Utilization
3112 # balancing mode.
3113 #
3114 # Not available if the backend&#x27;s balancingMode isRATE.
3115 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
3116 # For usage guidelines, seeConnection
3117 # balancing mode and Utilization
3118 # balancing mode.
3119 #
3120 # Not available if the backend&#x27;s balancingMode isRATE.
3121 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
3122 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
3123 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
3124 # Not available if backend&#x27;s balancingMode is RATE
3125 # or CONNECTION.
3126 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
3127 # Not available if backend&#x27;s balancingMode is RATE
3128 # or CONNECTION.
3129 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
3130 # usage guidelines, seeRate
3131 # balancing mode and Utilization
3132 # balancing mode.
3133 #
3134 # Not available if the backend&#x27;s balancingMode isCONNECTION.
3135 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
3136 # guidelines, seeRate
3137 # balancing mode and Utilization
3138 # balancing mode.
3139 #
3140 # Not available if the backend&#x27;s balancingMode isCONNECTION.
3141 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
3142 # guidelines, seeRate
3143 # balancing mode and Utilization
3144 # balancing mode.
3145 #
3146 # Not available if the backend&#x27;s balancingMode isCONNECTION.
3147 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
3148 #
3149 # For usage guidelines, seeUtilization
3150 # balancing mode.
3151 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
3152 # the backend.
3153 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
3154 },
3155 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
3156 # sending traffic to backends with default preference. The possible values
3157 # are:
3158 #
3159 # - PREFERRED: Backends with this preference level will be
3160 # filled up to their capacity limits first, based on RTT.
3161 # - DEFAULT: If preferred backends don&#x27;t have enough
3162 # capacity, backends in this layer would be used and traffic would be
3163 # assigned based on the load balancing algorithm you use. This is the
3164 # default
3165 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
3166 # Attachment).
3167 # e.g.
3168 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
3169 # for Cloud Run service.
3170 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
3171 # for PSC Service Attachment.
3172 &quot;trafficDuration&quot;: &quot;A String&quot;,
3173 },
3174 ],
3175 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
3176 # specified load balancer types.
3177 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
3178 # Pragma or Authorization headers. Up to 5 headers can be specified.
3179 # The cache is bypassed for all cdnPolicy.cacheMode settings.
3180 { # Bypass the cache when the specified request headers are present,
3181 # e.g. Pragma or Authorization headers. Values are case insensitive.
3182 # The presence of such a header overrides the cache_mode setting.
3183 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
3184 # Values are case-insensitive.
3185 },
3186 ],
3187 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
3188 # CDN.
3189 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
3190 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
3191 &quot;A String&quot;,
3192 ],
3193 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
3194 # The name=value pair will be used in the cache key Cloud CDN generates.
3195 &quot;A String&quot;,
3196 ],
3197 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
3198 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
3199 # query_string_whitelist and query_string_blacklist. If neither is set, the
3200 # entire query string will be included. If false, the query string will be
3201 # excluded from the cache key entirely.
3202 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
3203 # parameters will be included. Either specify query_string_whitelist or
3204 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
3205 # not treated as delimiters.
3206 &quot;A String&quot;,
3207 ],
3208 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
3209 # parameters will be excluded. Either specify query_string_whitelist or
3210 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
3211 # not treated as delimiters.
3212 &quot;A String&quot;,
3213 ],
3214 },
3215 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
3216 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
3217 # headers to cache content. Responses without these headers will not be
3218 # cached at Google&#x27;s edge, and will require a full trip to the origin on
3219 # every request, potentially impacting performance and increasing load on
3220 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
3221 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
3222 # Warning: this may result in Cloud CDN caching private,
3223 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
3224 # including common image formats, media (video and audio), and web assets
3225 # (JavaScript and CSS). Requests and responses that are marked as
3226 # uncacheable, as well as dynamic content (including HTML), will not be
3227 # cached.
3228 #
3229 # If no value is provided for cdnPolicy.cacheMode, it defaults
3230 # to CACHE_ALL_STATIC.
3231 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
3232 # used to clamp the max-age (or Expires) value sent to the client. With
3233 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
3234 # response max-age directive, along with a &quot;public&quot; directive. For
3235 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
3236 # from the origin (if specified), or else sets the response max-age
3237 # directive to the lesser of the client_ttl and default_ttl, and also
3238 # ensures a &quot;public&quot; cache-control directive is present.
3239 # If a client TTL is not specified, a default value (1 hour) will be used.
3240 # The maximum allowed value is 31,622,400s (1 year).
3241 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
3242 # responses that do not have an existing valid TTL (max-age or s-maxage).
3243 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
3244 # The value of defaultTTL cannot be set to a value greater than that of
3245 # maxTTL, but can be equal.
3246 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
3247 # will overwrite the TTL set in all responses. The maximum allowed value is
3248 # 31,622,400s (1 year), noting that infrequently accessed objects may be
3249 # evicted from the cache before the defined TTL.
3250 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
3251 # origin.
3252 # Cache directives that attempt to set a max-age or s-maxage higher than
3253 # this, or an Expires header more than maxTTL seconds in the future will
3254 # be capped at the value of maxTTL, as if it were the value of an
3255 # s-maxage Cache-Control directive.
3256 # Headers sent to the client will not be modified.
3257 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
3258 # The maximum allowed value is 31,622,400s (1 year), noting that
3259 # infrequently accessed objects may be evicted from the cache before
3260 # the defined TTL.
3261 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
3262 # to apply fine-grained caching for common errors or redirects.
3263 # This can reduce the load on your origin and improve end-user
3264 # experience by reducing response latency.
3265 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
3266 # negative caching applies to responses with the specified response code
3267 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
3268 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
3269 # to all responses with the specified response code, and override any
3270 # caching headers.
3271 # By default, Cloud CDN will apply the following default TTLs to these
3272 # status codes:
3273 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
3274 # HTTP 404 (Not Found), 410 (Gone),
3275 # 451 (Unavailable For Legal Reasons): 120s
3276 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
3277 # These defaults can be overridden in negative_caching_policy.
3278 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
3279 # negative_caching must be enabled to configure negative_caching_policy.
3280 # Omitting the policy and leaving negative_caching enabled will use
3281 # Cloud CDN&#x27;s default cache TTLs.
3282 # Note that when specifying an explicit negative_caching_policy, you
3283 # should take care to specify a cache TTL for all response codes
3284 # that you wish to cache. Cloud CDN will not apply any default
3285 # negative caching when a policy exists.
3286 { # Specify CDN TTLs for response error codes.
3287 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
3288 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
3289 # specified as values, and you cannot specify a status code more than
3290 # once.
3291 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
3292 # corresponding status code.
3293 # The maximum allowed value is 1800s (30 minutes), noting that
3294 # infrequently accessed objects may be evicted from the cache before the
3295 # defined TTL.
3296 },
3297 ],
3298 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
3299 # requests into a small number of requests to the origin.
3300 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
3301 # content with the origin, or when an error is encountered when refreshing
3302 # the cache.
3303 # This setting defines the default &quot;max-stale&quot; duration for any cached
3304 # responses that do not specify a max-stale directive. Stale responses that
3305 # exceed the TTL configured here will not be served. The default limit
3306 # (max-stale) is 86400s (1 day), which will allow stale content to be
3307 # served up to this limit beyond the max-age (or s-maxage) of a cached
3308 # response.
3309 # The maximum allowed value is 604800 (1 week).
3310 # Set this to zero (0) to disable serve-while-stale.
3311 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
3312 # considered fresh. After this time period, the response will be
3313 # revalidated before being served. Defaults to 1hr (3600s). When serving
3314 # responses to signed URL requests, Cloud CDN will internally behave as
3315 # though all responses from this backend had a &quot;Cache-Control:
3316 # public, max-age=[TTL]&quot; header, regardless of any existing
3317 # Cache-Control header. The actual headers served in responses will not be
3318 # altered.
3319 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
3320 &quot;A String&quot;,
3321 ],
3322 },
3323 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
3324 # backend service.
3325 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
3326 # as a count of seconds and fractions of seconds at nanosecond
3327 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3328 # or &quot;month&quot;. Range is approximately 10,000 years.
3329 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3330 # Durations less than one second are represented with a 0
3331 # `seconds` field and a positive `nanos` field. Must be from 0
3332 # to 999,999,999 inclusive.
3333 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3334 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3335 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3336 },
3337 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
3338 # there is no limit.
3339 #
3340 # Not supported when the backend service is referenced by a URL map that is
3341 # bound to target gRPC proxy that has validateForProxyless field set to true.
3342 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
3343 # not specified, there is no limit.
3344 #
3345 # Not supported when the backend service is referenced by a URL map that is
3346 # bound to target gRPC proxy that has validateForProxyless field set to true.
3347 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
3348 # service. If not specified, there is no limit.
3349 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
3350 # This parameter is respected by both the HTTP/1.1 and HTTP/2
3351 # implementations. If not specified, there is no limit. Setting this
3352 # parameter to 1 will effectively disable keep alive.
3353 #
3354 # Not supported when the backend service is referenced by a URL map that is
3355 # bound to target gRPC proxy that has validateForProxyless field set to true.
3356 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
3357 # not specified, the default is 1.
3358 #
3359 # Not supported when the backend service is referenced by a URL map that is
3360 # bound to target gRPC proxy that has validateForProxyless field set to true.
3361 },
3362 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
3363 # the client&#x27;s Accept-Encoding header.
3364 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
3365 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
3366 # instance. For supported load balancers and protocols, as described inEnabling
3367 # connection draining.
3368 },
3369 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
3370 # tracking policy settings are only available for external passthrough
3371 # Network Load Balancers and internal passthrough Network Load Balancers.
3372 #
3373 # connectionTrackingPolicy cannot be specified with haPolicy.
3374 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
3375 # value is DEFAULT_FOR_PROTOCOL.
3376 #
3377 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
3378 # persist on unhealthy backends only for connection-oriented protocols
3379 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
3380 # Affinity is configured for 5-tuple. They do not persist forUDP.
3381 #
3382 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
3383 # the existing connections on the unhealthy backend are never persisted on
3384 # the unhealthy backend. They are always diverted to newly selected healthy
3385 # backends (unless all backends are unhealthy).
3386 #
3387 # If set to ALWAYS_PERSIST, existing connections always
3388 # persist on unhealthy backends regardless of protocol and session
3389 # affinity. It is generally not recommended to use this mode overriding the
3390 # default.
3391 #
3392 # For more details, see [Connection Persistence for Network Load
3393 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
3394 # and [Connection Persistence for Internal TCP/UDP Load
3395 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
3396 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
3397 # Balancers. This option is not available publicly.
3398 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
3399 # matching traffic (in seconds).
3400 #
3401 # For internal passthrough Network Load Balancers:
3402 #
3403 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
3404 # - It can be set only if Connection Tracking is less than 5-tuple
3405 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
3406 # Mode is PER_SESSION).
3407 #
3408 #
3409 #
3410 # For external passthrough Network Load Balancers the default is 60
3411 # seconds. This option is not available publicly.
3412 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
3413 # options:
3414 #
3415 # - PER_CONNECTION: This is the default mode. The Connection
3416 # Tracking is performed as per the Connection Key (default Hash Method) for
3417 # the specific protocol.
3418 # - PER_SESSION: The Connection Tracking is performed as per
3419 # the configured Session Affinity. It matches the configured Session
3420 # Affinity.
3421 #
3422 #
3423 #
3424 # For more details, see [Tracking Mode for Network Load
3425 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
3426 # and [Tracking Mode for Internal TCP/UDP Load
3427 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
3428 },
3429 &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
3430 # affinity based on HTTP headers, cookies or other properties. This load
3431 # balancing policy is applicable only for HTTP connections. The affinity to a
3432 # particular destination host will be lost when one or more hosts are
3433 # added/removed from the destination service. This field specifies parameters
3434 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
3435 #
3436 # This field is applicable to either:
3437 #
3438 # - A regional backend service with the service protocol set to HTTP,
3439 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3440 # INTERNAL_MANAGED.
3441 # - A global backend service with the
3442 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3443 &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
3444 # be used as the hash key for the consistent hash load balancer. If the
3445 # cookie is not present, it will be generated. This field is applicable if
3446 # the sessionAffinity is set to HTTP_COOKIE.
3447 #
3448 # Not supported when the backend service is referenced by a URL map that is
3449 # bound to target gRPC proxy that has validateForProxyless field set to true.
3450 # for load balancing policies that use a consistent hash.
3451 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3452 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3453 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3454 # as a count of seconds and fractions of seconds at nanosecond
3455 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3456 # or &quot;month&quot;. Range is approximately 10,000 years.
3457 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3458 # Durations less than one second are represented with a 0
3459 # `seconds` field and a positive `nanos` field. Must be from 0
3460 # to 999,999,999 inclusive.
3461 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3462 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3463 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3464 },
3465 },
3466 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
3467 # applicable if the sessionAffinity is set toHEADER_FIELD.
3468 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
3469 # 1024. Larger ring sizes result in more granular load distributions. If the
3470 # number of hosts in the load balancing pool is larger than the ring size,
3471 # each host will be assigned a single virtual node.
3472 },
3473 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3474 # text format.
3475 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
3476 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
3477 # locality_lb_policy.
3478 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
3479 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
3480 # long and match the regular expression
3481 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
3482 # first character must be a lowercase letter, and all following
3483 # characters must be a dash, period, underscore, lowercase letter, or
3484 # digit, except the last character, which cannot be a dash, period, or
3485 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
3486 # field can only be used for a global or regional backend service with the
3487 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
3488 },
3489 ],
3490 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
3491 # custom
3492 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
3493 &quot;A String&quot;,
3494 ],
3495 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
3496 # custom
3497 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
3498 &quot;A String&quot;,
3499 ],
3500 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3501 # create the resource.
3502 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
3503 # backend service with dynamic forwarding feature which together with Service
3504 # Extension allows customized and complex routing logic.
3505 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
3506 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
3507 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
3508 },
3509 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
3510 # service. Some ranges are restricted: Restricted
3511 # ranges.
3512 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
3513 },
3514 },
3515 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
3516 # this backend service.
3517 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
3518 # global external Application Load Balancer.
3519 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
3520 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
3521 #
3522 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
3523 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
3524 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
3525 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
3526 # externalManagedMigrationTestingPercentage.
3527 #
3528 # Rolling back a migration requires the states to be set in reverse order. So
3529 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
3530 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
3531 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
3532 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
3533 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
3534 # external Application Load Balancer.
3535 #
3536 # The value of this field must be in the range [0, 100].
3537 #
3538 # Session affinity options will slightly affect this routing behavior, for
3539 # more details, see:Session
3540 # Affinity.
3541 #
3542 # This value can only be set if the loadBalancingScheme in the BackendService
3543 # is set to EXTERNAL (when using the classic Application Load Balancer) and
3544 # the migration state is TEST_BY_PERCENTAGE.
3545 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
3546 # as a backup (failover) backend.
3547 # For load balancers that have configurable failover:
3548 # [Internal passthrough Network Load
3549 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3550 # and [external passthrough Network Load
3551 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3552 #
3553 # failoverPolicy cannot be specified with haPolicy.
3554 # failover:
3555 # [Internal passthrough Network Load
3556 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3557 # and [external passthrough
3558 # Network Load
3559 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3560 # On failover or failback, this field indicates whether connection draining
3561 # will be honored. Google Cloud has a fixed connection draining timeout of
3562 # 10 minutes. A setting of true terminates existing TCP
3563 # connections to the active pool during failover and failback, immediately
3564 # draining traffic. A setting of false allows existing TCP
3565 # connections to persist, even on VMs no longer in the active pool, for up
3566 # to the duration of the connection draining timeout (10 minutes).
3567 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
3568 #
3569 # The default is false.
3570 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
3571 # load balancer are dropped when all primary and all backup backend VMs are
3572 # unhealthy.If set to false, connections are distributed
3573 # among all primary VMs when all primary and all backup backend VMs are
3574 # unhealthy.
3575 # For load balancers that have configurable
3576 # failover:
3577 # [Internal passthrough
3578 # Network Load
3579 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3580 # and [external passthrough
3581 # Network Load
3582 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3583 # The default is false.
3584 &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
3585 # failover when the number of healthy primary VMs equals zero.
3586 # For all other values, the load balancer performs a failover when the
3587 # total number of healthy primary VMs is less than this ratio.
3588 # For load balancers that have configurable
3589 # failover:
3590 # [Internal TCP/UDP Load
3591 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3592 # and [external TCP/UDP Load
3593 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3594 },
3595 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
3596 # This field is used in optimistic locking. This field will be ignored when
3597 # inserting a BackendService. An up-to-date fingerprint must be provided in
3598 # order to update the BackendService, otherwise the request will
3599 # fail with error 412 conditionNotMet.
3600 #
3601 # To see the latest fingerprint, make a get() request to
3602 # retrieve a BackendService.
3603 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
3604 # Protocol Forwarding.
3605 #
3606 # The backends of this regional backend service must only specify zonal
3607 # network endpoint groups (NEGs) of type GCE_VM_IP.
3608 #
3609 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
3610 # regional backend service must set the network field. All zonal NEGs must
3611 # belong to the same network. However, individual NEGs can
3612 # belong to different subnetworks of that network.
3613 #
3614 # When haPolicy is specified, the set of attached network endpoints across
3615 # all backends comprise an High Availability domain from which one endpoint
3616 # is selected as the active endpoint (the leader) that receives all
3617 # traffic.
3618 #
3619 # haPolicy can be added only at backend service creation time. Once set up,
3620 # it cannot be deleted.
3621 #
3622 # Note that haPolicy is not for load balancing, and therefore cannot be
3623 # specified with sessionAffinity, connectionTrackingPolicy, and
3624 # failoverPolicy.
3625 #
3626 # haPolicy requires customers to be responsible for tracking backend
3627 # endpoint health and electing a leader among the healthy endpoints.
3628 # Therefore, haPolicy cannot be specified with healthChecks.
3629 #
3630 # haPolicy can only be specified for External Passthrough Network Load
3631 # Balancers and Internal Passthrough Network Load Balancers.
3632 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
3633 # achieve it.
3634 #
3635 # Supported values are:
3636 #
3637 # - DISABLED: Fast IP Move is disabled. You can only use the
3638 # haPolicy.leader API to update the leader.
3639 # - &gt;GARP_RA: Provides a method to very quickly define a new network
3640 # endpoint as the leader. This method is faster than updating the leader
3641 # using the haPolicy.leader API. Fast IP move works as follows: The VM
3642 # hosting the network endpoint that should become the new leader sends
3643 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
3644 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
3645 # temporarily associates the forwarding rule IP address with that VM, and
3646 # both new and in-flight packets are quickly delivered to that VM.
3647 #
3648 #
3649 #
3650 # Note the important properties of the Fast IP Move functionality:
3651 #
3652 # - The GARP/RA-initiated re-routing stays active for approximately 20
3653 # minutes. After triggering fast failover, you must also
3654 # appropriately set the haPolicy.leader.
3655 # - The new leader instance should continue to send GARP/RA packets
3656 # periodically every 10 seconds until at least 10 minutes after updating
3657 # the haPolicy.leader (but stop immediately if it is no longer the leader).
3658 # - After triggering a fast failover, we recommend that you wait at least
3659 # 3 seconds before sending another GARP/RA packet from a different VM
3660 # instance to avoid race conditions.
3661 # - Don&#x27;t send GARP/RA packets from different VM
3662 # instances at the same time. If multiple instances continue to send
3663 # GARP/RA packets, traffic might be routed to different destinations in an
3664 # alternating order. This condition ceases when a single instance
3665 # issues a GARP/RA packet.
3666 # - The GARP/RA request always takes priority over the leader API.
3667 # Using the haPolicy.leader API to change the leader to a different
3668 # instance will have no effect until the GARP/RA request becomes
3669 # inactive.
3670 # - The GARP/RA packets should follow the GARP/RA
3671 # Packet Specifications..
3672 # - When multiple forwarding rules refer to a regional backend service,
3673 # you need only send a GARP or RA packet for a single forwarding rule
3674 # virtual IP. The virtual IPs for all forwarding rules targeting the same
3675 # backend service will also be moved to the sender of the GARP or RA
3676 # packet.
3677 #
3678 #
3679 #
3680 # The following are the Fast IP Move limitations (that is, when fastIPMove
3681 # is not DISABLED):
3682 #
3683 # - Multiple forwarding rules cannot use the same IP address if one of
3684 # them refers to a regional backend service with fastIPMove.
3685 # - The regional backend service must set the network field, and all
3686 # NEGs must belong to that network. However, individual
3687 # NEGs can belong to different subnetworks of that network.
3688 # - The maximum number of network endpoints across all backends of a
3689 # backend service with fastIPMove is 32.
3690 # - The maximum number of backend services with fastIPMove that can have
3691 # the same network endpoint attached to one of its backends is 64.
3692 # - The maximum number of backend services with fastIPMove in a VPC in a
3693 # region is 64.
3694 # - The network endpoints that are attached to a backend of a backend
3695 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
3696 # - Traffic directed to the leader by a static route next hop will not be
3697 # redirected to a new leader by fast failover. Such traffic will only be
3698 # redirected once an haPolicy.leader update has taken effect. Only traffic
3699 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
3700 # fast failover.
3701 #
3702 #
3703 # haPolicy.fastIPMove can be set only at backend service creation time.
3704 # Once set, it cannot be updated.
3705 #
3706 # By default, fastIpMove is set to DISABLED.
3707 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
3708 # this service as the active endpoint (the leader) that receives all
3709 # traffic.
3710 #
3711 # When the leader changes, there is no connection draining to persist
3712 # existing connections on the old leader.
3713 #
3714 # You are responsible for selecting a suitable endpoint as the
3715 # leader. For example, preferring a healthy endpoint over unhealthy ones.
3716 # Note that this service does not track backend endpoint health, and
3717 # selects the configured leader unconditionally.
3718 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
3719 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
3720 # that the leader is attached to.
3721 #
3722 # The leader&#x27;s backendGroup must already be specified as a backend of
3723 # this backend service. Removing a backend that is designated as the
3724 # leader&#x27;s backendGroup is not permitted.
3725 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
3726 # designated as the leader.
3727 #
3728 # This network endpoint cannot be detached from the NEG specified in
3729 # the haPolicy.leader.backendGroup until the leader is updated with
3730 # another network endpoint, or the leader is removed from the haPolicy.
3731 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
3732 # instance must already be attached to the NEG specified in the
3733 # haPolicy.leader.backendGroup.
3734 #
3735 # The name must be 1-63 characters long, and comply with RFC1035.
3736 # Authorization requires the following IAM permission on the
3737 # specified resource instance: compute.instances.use
3738 },
3739 },
3740 },
3741 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
3742 # httpsHealthChecks (legacy) resource for health checking this backend
3743 # service. Not all backend services support legacy health checks. See
3744 # Load balancer guide. Currently, at most one health check can be
3745 # specified for each backend service. Backend services with
3746 # instance group or zonal NEG backends must have a health check unless
3747 # haPolicy is specified. Backend services with internet or serverless NEG
3748 # backends must not have a health check.
3749 #
3750 # healthChecks[] cannot be specified with haPolicy.
3751 &quot;A String&quot;,
3752 ],
3753 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
3754 # Not available for internal passthrough Network Load Balancers and external
3755 # passthrough Network Load Balancers.
3756 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
3757 # incoming requests.
3758 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
3759 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
3760 # for IAP.
3761 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
3762 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
3763 # Optional - If not provided, the name will be autogenerated by the
3764 # backend.
3765 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
3766 },
3767 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
3768 # For security reasons, this value cannot be retrieved via the API.
3769 # Instead, the SHA-256 hash of the value is returned in the
3770 # oauth2ClientSecretSha256 field.
3771 #
3772 # @InputOnly
3773 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
3774 },
3775 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3776 # defined by the server.
3777 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
3778 # from the client to the backend for proxyless gRPC).
3779 # The possible values are:
3780 #
3781 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
3782 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3783 # Group), regardless of traffic from the client to the proxy. Only IPv4
3784 # health checks are used to check the health of the backends. This is the
3785 # default setting.
3786 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
3787 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
3788 # address).
3789 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
3790 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3791 # Group), regardless of traffic from the client to the proxy. Only IPv6
3792 # health checks are used to check the health of the backends.
3793 #
3794 #
3795 #
3796 # This field is applicable to either:
3797 #
3798 # - Advanced global external Application Load Balancer (load balancing
3799 # scheme EXTERNAL_MANAGED),
3800 # - Regional external Application Load
3801 # Balancer,
3802 # - Internal proxy Network Load Balancer (load balancing
3803 # scheme INTERNAL_MANAGED),
3804 # - Regional internal Application Load
3805 # Balancer (load balancing scheme INTERNAL_MANAGED),
3806 # - Traffic
3807 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
3808 # INTERNAL_SELF_MANAGED).
3809 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
3810 # for backend services.
3811 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
3812 # created for one type of load balancer cannot be used with another.
3813 # For more information, refer toChoosing
3814 # a load balancer.
3815 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
3816 # preference. When you use localityLbPolicies, you must set at least one
3817 # value for either the localityLbPolicies[].policy or the
3818 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
3819 # value set in the localityLbPolicy field.
3820 #
3821 # For an example of how to use this field, seeDefine
3822 # a list of preferred policies.
3823 #
3824 # Caution: This field and its children are intended for use in a service mesh
3825 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
3826 # that have this configuration.
3827 { # Container for either a built-in LB policy supported by gRPC or Envoy or
3828 # a custom one implemented by the end user.
3829 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
3830 # deployed with the client.
3831 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
3832 # by a locally installed custom policy implementation.
3833 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
3834 #
3835 # The value should match the name of a custom implementation registered
3836 # on the gRPC clients. It should follow protocol buffer message naming
3837 # conventions and include the full path (for example,
3838 # myorg.CustomLbPolicy). The maximum length is 256 characters.
3839 #
3840 # Do not specify the same custom policy more than once for a
3841 # backend. If you do, the configuration is rejected.
3842 #
3843 # For an example of how to use this field, seeUse
3844 # a custom policy.
3845 },
3846 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
3847 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
3848 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
3849 # about these values, see the description of localityLbPolicy.
3850 #
3851 # Do not specify the same policy more than once for a
3852 # backend. If you do, the configuration is rejected.
3853 },
3854 },
3855 ],
3856 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
3857 # possible values are:
3858 #
3859 # - ROUND_ROBIN: This is a simple policy in which each healthy
3860 # backend is selected in round robin order. This is the default.
3861 # - LEAST_REQUEST: An O(1) algorithm which
3862 # selects two random healthy hosts and picks the host which has fewer active
3863 # requests.
3864 # - RING_HASH: The ring/modulo hash load balancer implements
3865 # consistent hashing to backends. The algorithm has the property that the
3866 # addition/removal of a host from a set of N hosts only affects 1/N of the
3867 # requests.
3868 # - RANDOM: The load balancer selects a random healthy
3869 # host.
3870 # - ORIGINAL_DESTINATION: Backend host is selected
3871 # based on the client connection metadata, i.e., connections are opened to
3872 # the same address as the destination address of the incoming connection
3873 # before the connection was redirected to the load balancer.
3874 # - MAGLEV: used as a drop in replacement for the ring hash
3875 # load balancer. Maglev is not as stable as ring hash but has faster table
3876 # lookup build times and host selection times. For more information about
3877 # Maglev, see Maglev:
3878 # A Fast and Reliable Software Network Load Balancer.
3879 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
3880 # Load Balancing using weights computed from Backend reported Custom Metrics.
3881 # If set, the Backend Service responses are expected to contain non-standard
3882 # HTTP response header field Endpoint-Load-Metrics. The reported
3883 # metrics to use for computing the weights are specified via thecustomMetrics field.
3884 #
3885 # This field is applicable to either:
3886 # - A regional backend service with the service protocol set to HTTP,
3887 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3888 # INTERNAL_MANAGED.
3889 # - A global backend service with the
3890 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
3891 # EXTERNAL_MANAGED.
3892 #
3893 #
3894 # If sessionAffinity is not configured—that is, if session
3895 # affinity remains at the default value of NONE—then the
3896 # default value for localityLbPolicy
3897 # is ROUND_ROBIN. If session affinity is set to a value other
3898 # than NONE,
3899 # then the default value for localityLbPolicy isMAGLEV.
3900 #
3901 # Only ROUND_ROBIN and RING_HASH are supported
3902 # when the backend service is referenced by a URL map that is bound to
3903 # target gRPC proxy that has validateForProxyless field set to true.
3904 #
3905 # localityLbPolicy cannot be specified with haPolicy.
3906 &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
3907 # by this backend service. If logging is enabled, logs will be exported to
3908 # Stackdriver.
3909 # backend service.
3910 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
3911 # traffic served by this backend service. The default value is false.
3912 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
3913 { # Determines which HTTP headers will be logged to Stackdriver.
3914 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3915 },
3916 ],
3917 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
3918 { # Determines which HTTP headers will be logged to Stackdriver.
3919 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3920 },
3921 ],
3922 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
3923 # This field can only be specified if logging is enabled for this backend
3924 # service. Configures whether all, none or a subset of optional fields
3925 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3926 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3927 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
3928 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
3929 # of optional fields you want to include in the logs. For example:
3930 # serverInstance, serverGkeDetails.cluster,
3931 # serverGkeDetails.pod.podNamespace
3932 &quot;A String&quot;,
3933 ],
3934 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
3935 # service. Configures whether all, none or a subset of optional fields
3936 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3937 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3938 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
3939 # service. The value of the field must be in [0, 1]. This configures the
3940 # sampling rate of requests to the load balancer where 1.0 means all logged
3941 # requests are reported and 0.0 means no logged requests are reported. The
3942 # default value is 1.0.
3943 },
3944 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
3945 # service. Duration is computed from the beginning of the stream until the
3946 # response has been completely processed, including all retries. A stream
3947 # that does not complete in this duration is closed.
3948 #
3949 # If not specified, there will be no timeout limit, i.e. the maximum
3950 # duration is infinite.
3951 #
3952 # This value can be overridden in the PathMatcher configuration of the
3953 # UrlMap that references this backend service.
3954 #
3955 # This field is only allowed when the loadBalancingScheme of
3956 # the backend service is INTERNAL_SELF_MANAGED.
3957 # as a count of seconds and fractions of seconds at nanosecond
3958 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3959 # or &quot;month&quot;. Range is approximately 10,000 years.
3960 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3961 # Durations less than one second are represented with a 0
3962 # `seconds` field and a positive `nanos` field. Must be from 0
3963 # to 999,999,999 inclusive.
3964 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3965 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3966 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3967 },
3968 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
3969 # controller and read by the backend RCTH
3970 &quot;a_key&quot;: &quot;A String&quot;,
3971 },
3972 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3973 # The name must be 1-63 characters long, and comply withRFC1035.
3974 # Specifically, the name must be 1-63 characters long and match the regular
3975 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3976 # character must be a lowercase letter, and all following characters must
3977 # be a dash, lowercase letter, or digit, except the last character, which
3978 # cannot be a dash.
3979 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
3980 #
3981 # This field must be set for Internal Passthrough Network Load Balancers when
3982 # the haPolicy is enabled, and for External Passthrough Network Load
3983 # Balancers when the haPolicy fastIpMove is enabled.
3984 #
3985 # 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.
3986 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
3987 # Load Balancers.
3988 #
3989 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
3990 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
3991 # endpoints in the local zone.
3992 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
3993 # possible values are:
3994 #
3995 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
3996 # is disabled. The load balancer distributes new connections to all
3997 # healthy backend endpoints across all zones.
3998 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
3999 # enabled. The load balancer distributes new connections to all healthy
4000 # backend endpoints in the local zone only. If there are no healthy
4001 # backend endpoints in the local zone, the load balancer distributes
4002 # new connections to all backend endpoints in the local zone.
4003 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
4004 # enabled. The load balancer distributes new connections to all healthy
4005 # backend endpoints in the local zone only. If there aren&#x27;t enough
4006 # healthy backend endpoints in the local zone, the load balancer
4007 # distributes new connections to all healthy backend endpoints across all
4008 # zones.
4009 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
4010 # of healthy backend endpoints in a zone to the count of backend
4011 # endpoints in that same zone is equal to or above this threshold, the
4012 # load balancer distributes new connections to all healthy endpoints in
4013 # the local zone only. When the ratio of the count of healthy backend
4014 # endpoints in a zone to the count of backend endpoints in that same
4015 # zone is below this threshold, the load balancer distributes all new
4016 # connections to all healthy endpoints across all zones.
4017 },
4018 },
4019 &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.
4020 # the backend service.
4021 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
4022 # service.
4023 },
4024 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
4025 # load balancing pool of each individual proxy instance that processes the
4026 # traffic for the given backend service. If not set, this feature is
4027 # considered disabled.
4028 #
4029 # Results of the outlier detection algorithm (ejection of endpoints from the
4030 # load balancing pool and returning them back to the pool) are executed
4031 # independently by each proxy instance of the load balancer. In most cases,
4032 # more than one proxy instance handles the traffic received by a backend
4033 # service. Thus, it is possible that an unhealthy endpoint is detected and
4034 # ejected by only some of the proxies, and while this happens, other proxies
4035 # may continue to send requests to the same unhealthy endpoint until they
4036 # detect and eject the unhealthy endpoint.
4037 #
4038 # Applicable backend endpoints can be:
4039 #
4040 # - VM instances in an Instance Group
4041 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
4042 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
4043 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
4044 # Functions Services
4045 # - Private Service Connect NEGs, that resolve to
4046 # Google-managed regional API endpoints or managed services published using
4047 # Private Service Connect
4048 #
4049 #
4050 #
4051 # Applicable backend service types can be:
4052 #
4053 # - A global backend service with the loadBalancingScheme set to
4054 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
4055 # - A regional backend
4056 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
4057 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
4058 # supported for Serverless NEGs.
4059 #
4060 #
4061 #
4062 # Not supported when the backend service is referenced by a URL map that is
4063 # bound to target gRPC proxy that has validateForProxyless field set to true.
4064 # pool for the backend service.
4065 &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
4066 # or 30s.
4067 #
4068 # After a backend endpoint is returned back to the load balancing pool, it
4069 # can be ejected again in another ejection analysis. Thus, the total ejection
4070 # time is equal to the base ejection time multiplied by the number of times
4071 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
4072 # as a count of seconds and fractions of seconds at nanosecond
4073 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4074 # or &quot;month&quot;. Range is approximately 10,000 years.
4075 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4076 # Durations less than one second are represented with a 0
4077 # `seconds` field and a positive `nanos` field. Must be from 0
4078 # to 999,999,999 inclusive.
4079 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4080 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4081 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4082 },
4083 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
4084 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
4085 # return code qualifies as an error. Defaults to 5.
4086 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
4087 # connection errors that are mapped to one of those status codes) before a
4088 # consecutive gateway failure ejection occurs. Defaults to 3.
4089 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
4090 # outlier status is detected through consecutive 5xx. This setting can be
4091 # used to disable ejection or to ramp it up slowly. Defaults to 0.
4092 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
4093 # outlier status is detected through consecutive gateway failures. This
4094 # setting can be used to disable ejection or to ramp it up slowly. Defaults
4095 # to 100.
4096 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
4097 # outlier status is detected through success rate statistics. This setting
4098 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
4099 #
4100 # Not supported when the backend service uses Serverless NEG.
4101 &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
4102 # ejections and backend endpoints being returned to service. The interval is
4103 # equal to the number of seconds as defined in
4104 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
4105 # in outlierDetection.interval.nanos. Defaults to 1 second.
4106 # as a count of seconds and fractions of seconds at nanosecond
4107 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4108 # or &quot;month&quot;. Range is approximately 10,000 years.
4109 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4110 # Durations less than one second are represented with a 0
4111 # `seconds` field and a positive `nanos` field. Must be from 0
4112 # to 999,999,999 inclusive.
4113 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4114 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4115 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4116 },
4117 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
4118 # backend service that can be ejected if the ejection conditions are met.
4119 # Defaults to 50%.
4120 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
4121 # enough request volume to detect success rate outliers. If the number of
4122 # backend endpoints is fewer than this setting, outlier detection via success
4123 # rate statistics is not performed for any backend endpoint in the load
4124 # balancing pool. Defaults to 5.
4125 #
4126 # Not supported when the backend service uses Serverless NEG.
4127 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
4128 # (as defined by the interval duration above) to include this backend
4129 # endpoint in success rate based outlier detection. If the volume is lower
4130 # than this setting, outlier detection via success rate statistics is not
4131 # performed for that backend endpoint. Defaults to 100.
4132 #
4133 # Not supported when the backend service uses Serverless NEG.
4134 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
4135 # outlier ejection. The ejection threshold is the difference between the mean
4136 # success rate, and the product of this factor and the standard deviation of
4137 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
4138 # is divided by a thousand to get a double. That is, if the desired factor
4139 # is 1.9, the runtime value should be 1900. Defaults to 1900.
4140 #
4141 # Not supported when the backend service uses Serverless NEG.
4142 },
4143 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
4144 # as part of resource payload.
4145 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
4146 # Tag keys and values have the same definition as resource
4147 # manager tags. The field is allowed for INSERT
4148 # only. The keys/values to set on the resource should be specified in
4149 # either ID { : } or Namespaced format
4150 # { : }.
4151 # For example the following are valid inputs:
4152 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
4153 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
4154 # Note:
4155 # * Invalid combinations of ID &amp; namespaced format is not supported. For
4156 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
4157 &quot;a_key&quot;: &quot;A String&quot;,
4158 },
4159 },
4160 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
4161 # the backend. The default value is 80.
4162 # For internal passthrough Network Load Balancers and external passthrough
4163 # Network Load Balancers, omit port.
4164 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
4165 # communication to the backend VMs in that group. The
4166 # named port must be [defined on each backend instance
4167 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
4168 # This parameter has no meaning if the backends are NEGs. For internal
4169 # passthrough Network Load Balancers and external passthrough Network Load
4170 # Balancers, omit port_name.
4171 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
4172 # with backends.
4173 #
4174 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
4175 # depending on the chosen load balancer or Traffic Director configuration.
4176 # Refer to the documentation for the load balancers or for Traffic Director
4177 # for more information.
4178 #
4179 # Must be set to GRPC when the backend service is referenced by a URL map
4180 # that is bound to target gRPC proxy.
4181 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
4182 # resides. This field is not applicable to global backend services.
4183 # You must specify this field as part of the HTTP request URL. It is
4184 # not settable as a field in the request body.
4185 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
4186 # backend service.
4187 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
4188 # service. This field is applicable to a global backend service with the
4189 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
4190 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
4191 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
4192 # be accepted on backends, and if authenticated, which method/certificate
4193 # will set the request principal.
4194 # request principal.
4195 # The authentication settings for the backend service.
4196 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
4197 # Similar to peers, these will be evaluated in order the first valid one
4198 # will be used to set origin identity. If none of these methods pass, the
4199 # request will be rejected with authentication failed error (401). Leave the
4200 # list empty if origin authentication is not required.
4201 { # [Deprecated] Configuration for the origin authentication method.
4202 # Configuration for the origin authentication method.
4203 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
4204 # JWT configuration for origin authentication.
4205 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
4206 # will be accepted if audiences is empty.
4207 # Examples: bookstore_android.apps.googleusercontent.com,
4208 # bookstore_web.apps.googleusercontent.com
4209 &quot;A String&quot;,
4210 ],
4211 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
4212 # email address.
4213 # Examples: https://securetoken.google.com,
4214 # [email protected]
4215 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
4216 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
4217 # request. If no explicit location is specified, the following default
4218 # locations are tried in order:
4219 #
4220 # 1. The Authorization header using the Bearer schema. See `here
4221 # `_. Example:
4222 #
4223 # Authorization: Bearer .
4224 #
4225 # 2. `access_token` query parameter. See `this
4226 # `_
4227 #
4228 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
4229 # from the locations its issuer specified or from the default locations.
4230 #
4231 # This field is set if JWT is sent in a request header. This field specifies
4232 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
4233 # header format will be x-goog-iap-jwt-assertion: .
4234 { # [Deprecated] This message specifies a header location to extract JWT token.
4235 # This message specifies a header location to extract JWT token.
4236 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
4237 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
4238 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
4239 # with a space at the end.
4240 },
4241 ],
4242 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
4243 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
4244 # JWT format in the query parameter is /path?jwt_token=.
4245 &quot;A String&quot;,
4246 ],
4247 },
4248 },
4249 ],
4250 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
4251 # They will be evaluated in order the first valid one will be used to set
4252 # peer identity. If none of these methods pass, the request will be rejected
4253 # with authentication failed error (401). Leave the list empty if peer
4254 # authentication is not required.
4255 { # [Deprecated] Configuration for the peer authentication method.
4256 # Configuration for the peer authentication method.
4257 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
4258 # Configuration for the mutual Tls mode for peer authentication.
4259 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
4260 # field can be set to one of the following:
4261 # STRICT: Client certificate must be presented, connection is in TLS.
4262 # PERMISSIVE: Client certificate can be omitted, connection can be either
4263 # plaintext or TLS.
4264 },
4265 },
4266 ],
4267 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
4268 # Default value is USE_PEER. If peer (or origin) identity is not available,
4269 # either because peer/origin authentication is not defined, or failed,
4270 # principal will be left unset. In other words, binding rule does not affect
4271 # the decision to accept or reject request. This field can be set to one of
4272 # the following:
4273 # USE_PEER: Principal will be set to the identity from peer authentication.
4274 # USE_ORIGIN: Principal will be set to the identity from origin
4275 # authentication.
4276 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
4277 # identity information.
4278 # The TLS settings for the client or server.
4279 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
4280 # certificate.
4281 # Defines the mechanism to obtain the client or server certificate.
4282 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
4283 # applicable only if tlsCertificateSource is set to USE_PATH.
4284 # The paths to the mounted TLS Certificates and private key.
4285 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4286 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4287 },
4288 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
4289 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
4290 # is applicable only if tlsCertificateSource is set to USE_SDS.
4291 # The configuration to access the SDS server.
4292 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
4293 # gRPC config to access the SDS server.
4294 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
4295 # gRPC call credentials to access the SDS server.
4296 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
4297 # This field can be set to one of the following:
4298 #
4299 # - GCE_VM: The local GCE VM service account credentials are used to access
4300 # the SDS server.
4301 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
4302 # SDS server.
4303 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
4304 # FROM_PLUGIN.
4305 # Custom authenticator credentials.
4306 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
4307 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
4308 # plugin.
4309 },
4310 },
4311 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
4312 # gRPC channel credentials to access the SDS server.
4313 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
4314 # The paths to the mounted TLS Certificates and private key.
4315 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4316 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4317 },
4318 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
4319 # to one of the following:
4320 # CERTIFICATES: Use TLS certificates to access the SDS server.
4321 # GCE_VM: Use local GCE VM credentials to access the SDS server.
4322 },
4323 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
4324 },
4325 },
4326 },
4327 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
4328 # validate the client/server certificate. If omitted, the proxy will not
4329 # validate the server or client certificate.
4330 # certificate to validate the client/server certificate.
4331 # validate the client/server certificate.
4332 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
4333 # client or server certificate.
4334 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
4335 # is applicable only if tlsCertificateSource is set to USE_SDS.
4336 # The configuration to access the SDS server.
4337 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
4338 # gRPC config to access the SDS server.
4339 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
4340 # gRPC call credentials to access the SDS server.
4341 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
4342 # This field can be set to one of the following:
4343 #
4344 # - GCE_VM: The local GCE VM service account credentials are used to access
4345 # the SDS server.
4346 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
4347 # SDS server.
4348 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
4349 # FROM_PLUGIN.
4350 # Custom authenticator credentials.
4351 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
4352 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
4353 # plugin.
4354 },
4355 },
4356 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
4357 # gRPC channel credentials to access the SDS server.
4358 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
4359 # The paths to the mounted TLS Certificates and private key.
4360 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4361 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4362 },
4363 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
4364 # to one of the following:
4365 # CERTIFICATES: Use TLS certificates to access the SDS server.
4366 # GCE_VM: Use local GCE VM credentials to access the SDS server.
4367 },
4368 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
4369 },
4370 },
4371 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
4372 },
4373 },
4374 },
4375 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
4376 # (RBAC) config.
4377 # Authorization config defines the Role Based Access Control (RBAC) config.
4378 # method-level access control for a service.
4379 # control for a service.
4380 &quot;policies&quot;: [ # List of RbacPolicies.
4381 {
4382 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
4383 &quot;permissions&quot;: [ # The list of permissions.
4384 { # [Deprecated] All fields defined in a permission are ANDed.
4385 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
4386 { # Custom constraint that specifies a key and a list of allowed values for
4387 # Istio attributes.
4388 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
4389 &quot;values&quot;: [ # A list of allowed values.
4390 &quot;A String&quot;,
4391 ],
4392 },
4393 ],
4394 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
4395 # applies to. Exact match, prefix match, and suffix match are supported.
4396 &quot;A String&quot;,
4397 ],
4398 &quot;methods&quot;: [ # HTTP method.
4399 &quot;A String&quot;,
4400 ],
4401 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
4402 &quot;A String&quot;,
4403 ],
4404 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
4405 &quot;A String&quot;,
4406 ],
4407 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
4408 &quot;A String&quot;,
4409 ],
4410 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
4411 &quot;A String&quot;,
4412 ],
4413 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
4414 # Exact match, prefix match, and suffix match are supported.
4415 &quot;A String&quot;,
4416 ],
4417 &quot;ports&quot;: [ # Port names or numbers.
4418 &quot;A String&quot;,
4419 ],
4420 },
4421 ],
4422 &quot;principals&quot;: [ # The list of principals.
4423 { # [Deprecated] All fields defined in a principal are ANDed.
4424 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
4425 &quot;groups&quot;: [ # The groups the principal belongs to.
4426 # Exact match, prefix match, and suffix match are supported.
4427 &quot;A String&quot;,
4428 ],
4429 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
4430 &quot;A String&quot;,
4431 ],
4432 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
4433 &quot;A String&quot;,
4434 ],
4435 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
4436 &quot;A String&quot;,
4437 ],
4438 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
4439 &quot;A String&quot;,
4440 ],
4441 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
4442 &quot;A String&quot;,
4443 ],
4444 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
4445 &quot;A String&quot;,
4446 ],
4447 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
4448 # suffix match are supported for values. For example,
4449 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
4450 &quot;a_key&quot;: &quot;A String&quot;,
4451 },
4452 &quot;users&quot;: [ # The user names/IDs or service accounts.
4453 # Exact match, prefix match, and suffix match are supported.
4454 &quot;A String&quot;,
4455 ],
4456 },
4457 ],
4458 },
4459 ],
4460 },
4461 &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
4462 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
4463 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
4464 # private storage buckets that support Signature Version 4 for authentication.
4465 # The service name for generating the authentication header will always default
4466 # to &#x27;s3&#x27;.
4467 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
4468 # creating a backend that uses AWS v4 signature authentication, but will not
4469 # be returned as part of the configuration when queried with a REST API GET
4470 # request.
4471 #
4472 # @InputOnly
4473 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
4474 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
4475 # keep track of different iterations of your access key.
4476 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
4477 # the name of the region your cloud uses to host your origin. For example,
4478 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
4479 },
4480 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
4481 # that describes how clients should authenticate with this service&#x27;s
4482 # backends.
4483 #
4484 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
4485 # to INTERNAL_SELF_MANAGED.
4486 #
4487 # If left blank, communications are not encrypted.
4488 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
4489 # originating from the backend service.
4490 # the backend service.
4491 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
4492 # identity information. This field is only applicable when mode is set to
4493 # MUTUAL.
4494 # The TLS settings for the client or server.
4495 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
4496 # certificate.
4497 # Defines the mechanism to obtain the client or server certificate.
4498 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
4499 # applicable only if tlsCertificateSource is set to USE_PATH.
4500 # The paths to the mounted TLS Certificates and private key.
4501 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4502 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4503 },
4504 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
4505 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
4506 # is applicable only if tlsCertificateSource is set to USE_SDS.
4507 # The configuration to access the SDS server.
4508 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
4509 # gRPC config to access the SDS server.
4510 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
4511 # gRPC call credentials to access the SDS server.
4512 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
4513 # This field can be set to one of the following:
4514 #
4515 # - GCE_VM: The local GCE VM service account credentials are used to access
4516 # the SDS server.
4517 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
4518 # SDS server.
4519 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
4520 # FROM_PLUGIN.
4521 # Custom authenticator credentials.
4522 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
4523 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
4524 # plugin.
4525 },
4526 },
4527 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
4528 # gRPC channel credentials to access the SDS server.
4529 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
4530 # The paths to the mounted TLS Certificates and private key.
4531 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4532 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4533 },
4534 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
4535 # to one of the following:
4536 # CERTIFICATES: Use TLS certificates to access the SDS server.
4537 # GCE_VM: Use local GCE VM credentials to access the SDS server.
4538 },
4539 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
4540 },
4541 },
4542 },
4543 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
4544 # validate the client/server certificate. If omitted, the proxy will not
4545 # validate the server or client certificate.
4546 # certificate to validate the client/server certificate.
4547 # validate the client/server certificate.
4548 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
4549 # client or server certificate.
4550 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
4551 # is applicable only if tlsCertificateSource is set to USE_SDS.
4552 # The configuration to access the SDS server.
4553 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
4554 # gRPC config to access the SDS server.
4555 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
4556 # gRPC call credentials to access the SDS server.
4557 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
4558 # This field can be set to one of the following:
4559 #
4560 # - GCE_VM: The local GCE VM service account credentials are used to access
4561 # the SDS server.
4562 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
4563 # SDS server.
4564 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
4565 # FROM_PLUGIN.
4566 # Custom authenticator credentials.
4567 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
4568 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
4569 # plugin.
4570 },
4571 },
4572 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
4573 # gRPC channel credentials to access the SDS server.
4574 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
4575 # The paths to the mounted TLS Certificates and private key.
4576 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
4577 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
4578 },
4579 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
4580 # to one of the following:
4581 # CERTIFICATES: Use TLS certificates to access the SDS server.
4582 # GCE_VM: Use local GCE VM credentials to access the SDS server.
4583 },
4584 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
4585 },
4586 },
4587 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
4588 },
4589 },
4590 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
4591 # The value of this field determines how TLS is enforced. This can be set
4592 # to one of the following values: DISABLE: Do not setup a TLS connection to
4593 # the backends.
4594 # SIMPLE: Originate a TLS connection to the backends.
4595 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
4596 # client certificates for authentication.
4597 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
4598 # applicable only when mode is SIMPLE or MUTUAL.
4599 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
4600 # certificate.If specified,
4601 # the proxy will verify that the server certificate&#x27;s subject alt name
4602 # matches one of the specified values. This field is applicable only when
4603 # mode is SIMPLE or MUTUAL.
4604 &quot;A String&quot;,
4605 ],
4606 },
4607 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
4608 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
4609 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
4610 # specified values, the communication continues. Otherwise, it fails. This
4611 # additional check enables the client to verify that the server is authorized
4612 # to run the requested service.
4613 #
4614 # Note that the contents of the server
4615 # certificate&#x27;s subjectAltName field are configured by the
4616 # Public Key Infrastructure which provisions server identities.
4617 #
4618 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
4619 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
4620 # mode).
4621 &quot;A String&quot;,
4622 ],
4623 },
4624 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4625 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4626 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
4627 #
4628 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
4629 # If set, lists of backends and health checks must be both empty.
4630 &quot;A String&quot;,
4631 ],
4632 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
4633 #
4634 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
4635 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
4636 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
4637 #
4638 # Only NONE and HEADER_FIELD are supported
4639 # when the backend service is referenced by a URL map that is bound to
4640 # target gRPC proxy that has validateForProxyless field set to true.
4641 #
4642 # For more details, see:
4643 # [Session
4644 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
4645 #
4646 # sessionAffinity cannot be specified with haPolicy.
4647 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
4648 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
4649 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
4650 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
4651 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
4652 # as a count of seconds and fractions of seconds at nanosecond
4653 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4654 # or &quot;month&quot;. Range is approximately 10,000 years.
4655 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4656 # Durations less than one second are represented with a 0
4657 # `seconds` field and a positive `nanos` field. Must be from 0
4658 # to 999,999,999 inclusive.
4659 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4660 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4661 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4662 },
4663 },
4664 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
4665 # Currently this is applicable only for Internal TCP/UDP load balancing,
4666 # Internal HTTP(S) load balancing and Traffic Director.
4667 &quot;policy&quot;: &quot;A String&quot;,
4668 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
4669 # each service mesh client.
4670 #
4671 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
4672 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
4673 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
4674 # `INTERNAL_SELF_MANAGED`.
4675 #
4676 # `subset_size` is optional for Internal HTTP(S) load balancing
4677 # and required for Traffic Director.
4678 #
4679 # If you do not provide this value, Cloud Load Balancing will calculate it
4680 # dynamically to optimize the number of proxies/clients visible to each
4681 # backend and vice versa.
4682 #
4683 # Must be greater than 0. If `subset_size` is larger than the number of
4684 # backends/endpoints, then subsetting is disabled.
4685 },
4686 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
4687 # type of load balancer. For more information see,
4688 # Backend service settings.
4689 # The default is 30 seconds.
4690 # The full range of timeout values allowed goes from 1
4691 # through 2,147,483,647 seconds.
4692 #
4693 # This value can be overridden in the PathMatcher configuration of the
4694 # UrlMap that references this backend service.
4695 #
4696 # Not supported when the backend service is referenced by a URL map that is
4697 # bound to target gRPC proxy that has validateForProxyless field set to true.
4698 # Instead, use maxStreamDuration.
4699 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
4700 # when the backend protocol is SSL, HTTPS or HTTP2.
4701 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
4702 # networksecurity.googleapis.com namespace. Can be used in authenticating
4703 # TLS connections to the backend, as specified by the authenticationMode
4704 # field. Can only be specified if authenticationMode is not NONE.
4705 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
4706 #
4707 #
4708 # Use this property to configure the load balancer back-end to use
4709 # certificates and roots of trust provisioned by the Managed Workload
4710 # Identity system.
4711 #
4712 # The `identity` property is the
4713 # fully-specified SPIFFE ID to use in the SVID presented by the Load
4714 # Balancer Workload.
4715 #
4716 # The SPIFFE ID must be a resource starting with the
4717 # `trustDomain` property value, followed by the path to the Managed
4718 # Workload Identity.
4719 #
4720 # Supported SPIFFE ID format:
4721 #
4722 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
4723 #
4724 #
4725 # The Trust Domain within the Managed Identity must refer to a valid
4726 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
4727 # will be inherited from the Workload Identity Pool.
4728 #
4729 # Restrictions:
4730 #
4731 # - If you set the `identity` property, you cannot manually set
4732 # the following fields:
4733 # - tlsSettings.sni
4734 # - tlsSettings.subjectAltNames
4735 # - tlsSettings.authenticationConfig
4736 #
4737 #
4738 # When defining a `identity` for a RegionBackendServices, the
4739 # corresponding Workload Identity Pool must have a ca_pool
4740 # configured in the same region.
4741 #
4742 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
4743 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
4744 # balancer sends this string as the SNI hostname in the TLS connection to
4745 # the backend, and requires that this string match a Subject Alternative
4746 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
4747 # NEG backend, if the SNI is specified here, the load balancer uses it
4748 # regardless of whether the Regional Internet NEG is specified with FQDN or
4749 # IP address and port. When both sni and subjectAltNames[] are specified,
4750 # the load balancer matches the backend certificate&#x27;s SAN only to
4751 # subjectAltNames[].
4752 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
4753 # verifies during a TLS handshake with the backend. When the server
4754 # presents its X.509 certificate to the Load Balancer, the Load Balancer
4755 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
4756 # match one of the subjectAltNames in the list. This field is limited to 5
4757 # entries. When both sni and subjectAltNames[] are specified, the load
4758 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
4759 { # A Subject Alternative Name that the load balancer matches against the SAN
4760 # field in the TLS certificate provided by the backend, specified as either
4761 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
4762 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
4763 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
4764 },
4765 ],
4766 },
4767 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
4768 {
4769 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
4770 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
4771 # and ForwardingRule.
4772 },
4773 ],
4774 }</pre>
4775 </div>
4776
4777 <div class="method">
4778 <code class="details" id="getEffectiveSecurityPolicies">getEffectiveSecurityPolicies(project, backendService, x__xgafv=None)</code>
4779 <pre>Returns effective security policies applied to this backend service.
4780
4781 Args:
4782 project: string, Project ID for this request. (required)
4783 backendService: string, Name of the Backend Service for this request. (required)
4784 x__xgafv: string, V1 error format.
4785 Allowed values
4786 1 - v1 error format
4787 2 - v2 error format
4788
4789 Returns:
4790 An object of the form:
4791
4792 {
4793 &quot;securityPolicies&quot;: [ # Effective security policies for the backend service.
4794 { # Represents a Google Cloud Armor security policy resource.
4795 #
4796 # Only external backend services that use load balancers can
4797 # reference a security policy. For more information, see
4798 # Google Cloud Armor security policy overview.
4799 &quot;adaptiveProtectionConfig&quot;: { # Configuration options for Cloud Armor Adaptive Protection (CAAP).
4800 &quot;autoDeployConfig&quot;: { # Configuration options for Adaptive Protection auto-deploy feature.
4801 &quot;confidenceThreshold&quot;: 3.14,
4802 &quot;expirationSec&quot;: 42,
4803 &quot;impactedBaselineThreshold&quot;: 3.14,
4804 &quot;loadThreshold&quot;: 3.14,
4805 },
4806 &quot;layer7DdosDefenseConfig&quot;: { # Configuration options for L7 DDoS detection. # If set to true, enables Cloud Armor Machine Learning.
4807 # This field is only supported in Global Security Policies of type
4808 # CLOUD_ARMOR.
4809 &quot;enable&quot;: True or False, # If set to true, enables CAAP for L7 DDoS detection.
4810 # This field is only supported in Global Security Policies of type
4811 # CLOUD_ARMOR.
4812 &quot;ruleVisibility&quot;: &quot;A String&quot;, # Rule visibility can be one of the following:
4813 # STANDARD - opaque rules. (default)
4814 # PREMIUM - transparent rules.
4815 # This field is only supported in Global Security Policies of type
4816 # CLOUD_ARMOR.
4817 &quot;thresholdConfigs&quot;: [ # Configuration options for layer7 adaptive protection for various
4818 # customizable thresholds.
4819 {
4820 &quot;autoDeployConfidenceThreshold&quot;: 3.14,
4821 &quot;autoDeployExpirationSec&quot;: 42,
4822 &quot;autoDeployImpactedBaselineThreshold&quot;: 3.14,
4823 &quot;autoDeployLoadThreshold&quot;: 3.14,
4824 &quot;detectionAbsoluteQps&quot;: 3.14,
4825 &quot;detectionLoadThreshold&quot;: 3.14,
4826 &quot;detectionRelativeToBaselineQps&quot;: 3.14,
4827 &quot;name&quot;: &quot;A String&quot;, # The name must be 1-63 characters long, and comply withRFC1035.
4828 # The name must be unique within the security policy.
4829 &quot;trafficGranularityConfigs&quot;: [ # Configuration options for enabling Adaptive Protection to operate
4830 # on specified granular traffic units.
4831 { # Configurations to specifc granular traffic units processed by
4832 # Adaptive Protection.
4833 &quot;enableEachUniqueValue&quot;: True or False, # If enabled, traffic matching each unique value for the specified
4834 # type constitutes a separate traffic unit.
4835 # It can only be set to true if `value` is empty.
4836 &quot;type&quot;: &quot;A String&quot;, # Type of this configuration.
4837 &quot;value&quot;: &quot;A String&quot;, # Requests that match this value constitute a granular traffic unit.
4838 },
4839 ],
4840 },
4841 ],
4842 },
4843 },
4844 &quot;advancedOptionsConfig&quot;: {
4845 &quot;jsonCustomConfig&quot;: { # Custom configuration to apply the JSON parsing. Only applicable when
4846 # json_parsing is set to STANDARD.
4847 &quot;contentTypes&quot;: [ # A list of custom Content-Type header values to apply the JSON parsing.
4848 #
4849 # As per RFC 1341, a Content-Type header value has the following format:
4850 #
4851 # Content-Type := type &quot;/&quot; subtype *[&quot;;&quot; parameter]
4852 #
4853 # When configuring a custom Content-Type header value, only the
4854 # type/subtype needs to be specified, and the parameters should be
4855 # excluded.
4856 &quot;A String&quot;,
4857 ],
4858 },
4859 &quot;jsonParsing&quot;: &quot;A String&quot;,
4860 &quot;logLevel&quot;: &quot;A String&quot;,
4861 &quot;requestBodyInspectionSize&quot;: &quot;A String&quot;, # The maximum request size chosen by the customer with Waf enabled.
4862 # Values supported are &quot;8KB&quot;, &quot;16KB, &quot;32KB&quot;, &quot;48KB&quot; and &quot;64KB&quot;.
4863 # Values are case insensitive.
4864 &quot;userIpRequestHeaders&quot;: [ # An optional list of case-insensitive request header names to use for
4865 # resolving the callers client IP address.
4866 &quot;A String&quot;,
4867 ],
4868 },
4869 &quot;associations&quot;: [ # A list of associations that belong to this policy.
4870 {
4871 &quot;attachmentId&quot;: &quot;A String&quot;, # The resource that the security policy is attached to.
4872 &quot;displayName&quot;: &quot;A String&quot;, # Output only. [Output Only] The display name of the security policy of the association.
4873 &quot;excludedFolders&quot;: [ # A list of folders to exclude from the security policy.
4874 &quot;A String&quot;,
4875 ],
4876 &quot;excludedProjects&quot;: [ # A list of projects to exclude from the security policy.
4877 &quot;A String&quot;,
4878 ],
4879 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4880 &quot;securityPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The security policy ID of the association.
4881 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the security policy of the association.
4882 },
4883 ],
4884 &quot;cloudArmorConfig&quot;: { # Configuration options for Cloud Armor.
4885 &quot;enableMl&quot;: True or False, # If set to true, enables Cloud Armor Machine Learning.
4886 },
4887 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4888 # text format.
4889 &quot;ddosProtectionConfig&quot;: {
4890 &quot;ddosAdaptiveProtection&quot;: &quot;A String&quot;,
4891 &quot;ddosImpactedBaselineThreshold&quot;: 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs)
4892 # builds DDoS mitigations that minimize collateral damage. It quantifies
4893 # this as the fraction of a non-abuse baseline that&#x27;s inadvertently
4894 # blocked.
4895 #
4896 # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will
4897 # not be deployed. Using a lower value will prioritize keeping collateral
4898 # damage low, possibly at the cost of its effectiveness in rate limiting
4899 # some or all of the attack. It should typically be unset, so Advanced DDoS
4900 # (and Adaptive Protection) uses the best mitigation it can find. Setting
4901 # the threshold is advised if there are logs for false positive detections
4902 # with high collateral damage, and will cause Advanced DDoS to attempt to
4903 # find a less aggressive rule that satisfies the constraint. If a suitable
4904 # rule cannot be found, the system falls back to either no mitigation for
4905 # smaller attacks or broader network throttles for larger ones.
4906 &quot;ddosProtection&quot;: &quot;A String&quot;,
4907 },
4908 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4909 # create the resource.
4910 &quot;displayName&quot;: &quot;A String&quot;, # User-provided name of the organization security policy. The name should be
4911 # unique in the organization in which the security policy is created. This
4912 # should only be used when SecurityPolicyType is FIREWALL.
4913 # The name must be 1-63 characters long, and comply with
4914 # https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63
4915 # characters long and match the regular expression
4916 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4917 # lowercase letter, and all following characters must be a dash, lowercase
4918 # letter, or digit, except the last character, which cannot be a dash.
4919 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4920 # the metadata&#x27;s contents and used for optimistic locking. The
4921 # fingerprint is initially generated by Compute Engine and changes after
4922 # every request to modify or update metadata. You must always provide an
4923 # up-to-date fingerprint hash in order to update or change metadata,
4924 # otherwise the request will fail with error412 conditionNotMet.
4925 #
4926 # To see the latest fingerprint, make get() request to the
4927 # security policy.
4928 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
4929 # defined by the server.
4930 &quot;kind&quot;: &quot;compute#securityPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies
4931 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this security policy, which
4932 # is essentially a hash of the labels set used for optimistic locking. The
4933 # fingerprint is initially generated by Compute Engine and changes after
4934 # every request to modify or update labels. You must always provide an
4935 # up-to-date fingerprint hash in order to update or change labels.
4936 #
4937 # To see the latest fingerprint, make get() request to the
4938 # security policy.
4939 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
4940 # Label values may be empty.
4941 &quot;a_key&quot;: &quot;A String&quot;,
4942 },
4943 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4944 # The name must be 1-63 characters long, and comply withRFC1035.
4945 # Specifically, the name must be 1-63 characters long and match the regular
4946 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4947 # character must be a lowercase letter, and all following characters must
4948 # be a dash, lowercase letter, or digit, except the last character, which
4949 # cannot be a dash.
4950 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the security policy.
4951 &quot;recaptchaOptionsConfig&quot;: {
4952 &quot;redirectSiteKey&quot;: &quot;A String&quot;, # An optional field to supply a reCAPTCHA site key to be used for all the
4953 # rules using the redirect action with the type of GOOGLE_RECAPTCHA under
4954 # the security policy. The specified site key needs to be created from the
4955 # reCAPTCHA API. The user is responsible for the validity of the specified
4956 # site key. If not specified, a Google-managed site key is used.
4957 # This field is only supported in Global Security Policies of type
4958 # CLOUD_ARMOR.
4959 },
4960 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional security policy
4961 # resides. This field is not applicable to global security policies.
4962 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all security policy rule tuples. A security
4963 # policy can not exceed a set number of tuples.
4964 &quot;rules&quot;: [ # A list of rules that belong to this policy.
4965 # There must always be a default rule which is a rule with priority
4966 # 2147483647 and match all condition (for the match condition this means
4967 # match &quot;*&quot; for srcIpRanges and for the networkMatch condition every field
4968 # must be either match &quot;*&quot; or not set). If no rules are provided when
4969 # creating a security policy, a default rule with action &quot;allow&quot; will be
4970 # added.
4971 { # Represents a rule that describes one or more match conditions along with
4972 # the action to be taken when traffic matches this condition (allow or deny).
4973 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the rule is matched.
4974 # The following are the valid actions:
4975 #
4976 # - allow: allow access to target.
4977 # - deny(STATUS): deny access to target, returns the
4978 # HTTP response code specified. Valid values for `STATUS`
4979 # are 403, 404, and 502.
4980 # - rate_based_ban: limit client traffic to the configured
4981 # threshold and ban the client if the traffic exceeds the threshold.
4982 # Configure parameters for this action in RateLimitOptions. Requires
4983 # rate_limit_options to be set.
4984 # - redirect: redirect to a different target. This can
4985 # either be an internal reCAPTCHA redirect, or an external URL-based
4986 # redirect via a 302 response. Parameters for this action can be configured
4987 # via redirectOptions. This action is only supported in Global Security
4988 # Policies of type CLOUD_ARMOR.
4989 # - throttle: limit
4990 # client traffic to the configured threshold. Configure parameters for this
4991 # action in rateLimitOptions. Requires rate_limit_options to be set for
4992 # this.
4993 # - fairshare (preview only): when traffic reaches the
4994 # threshold limit, requests from the clients matching this rule begin to be
4995 # rate-limited using the Fair Share algorithm. This action is only allowed
4996 # in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
4997 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4998 # create the resource.
4999 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies. This field may only be
5000 # specified when versioned_expr is set to FIREWALL.
5001 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
5002 # enabled, logs will be exported to the configured export destination in
5003 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
5004 # cannot enable logging on &quot;goto_next&quot; rules.
5005 #
5006 # This field may only be specified when the versioned_expr is set to
5007 # FIREWALL.
5008 &quot;headerAction&quot;: { # Optional, additional actions that are performed on headers.
5009 # This field is only supported in Global Security Policies of type
5010 # CLOUD_ARMOR.
5011 &quot;requestHeadersToAdds&quot;: [ # The list of request headers to add or overwrite if they&#x27;re already
5012 # present.
5013 {
5014 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to set.
5015 &quot;headerValue&quot;: &quot;A String&quot;, # The value to set the named header to.
5016 },
5017 ],
5018 },
5019 &quot;kind&quot;: &quot;compute#securityPolicyRule&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
5020 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
5021 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
5022 # Exactly one field must be specified.
5023 &quot;config&quot;: { # The configuration options available when specifying versioned_expr.
5024 # This field must be specified if versioned_expr is specified and cannot
5025 # be specified if versioned_expr is not specified.
5026 &quot;destIpRanges&quot;: [ # CIDR IP address range.
5027 #
5028 # This field may only be specified when versioned_expr is set to
5029 # FIREWALL.
5030 &quot;A String&quot;,
5031 ],
5032 &quot;destPorts&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5033 #
5034 # This field may only be specified when versioned_expr is set to
5035 # FIREWALL.
5036 {
5037 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5038 # required when creating a firewall rule. This value can either be
5039 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5040 # protocol number.
5041 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5042 # only applicable for UDP or TCP protocol. Each entry must be either
5043 # an integer or a range. If not specified, this rule applies to
5044 # connections through any port.
5045 #
5046 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5047 #
5048 # This field may only be specified when versioned_expr is set to
5049 # FIREWALL.
5050 &quot;A String&quot;,
5051 ],
5052 },
5053 ],
5054 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
5055 #
5056 # This field may only be specified when versioned_expr is set to
5057 # FIREWALL.
5058 {
5059 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
5060 # required when creating a firewall rule. This value can either be
5061 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
5062 # protocol number.
5063 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
5064 # only applicable for UDP or TCP protocol. Each entry must be either
5065 # an integer or a range. If not specified, this rule applies to
5066 # connections through any port.
5067 #
5068 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
5069 #
5070 # This field may only be specified when versioned_expr is set to
5071 # FIREWALL.
5072 &quot;A String&quot;,
5073 ],
5074 },
5075 ],
5076 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
5077 # Maximum number of src_ip_ranges allowed is 10.
5078 &quot;A String&quot;,
5079 ],
5080 },
5081 &quot;expr&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # User defined CEVAL expression.
5082 # A CEVAL expression is used to specify match criteria such as origin.ip,
5083 # source.region_code and contents in the request header.
5084 # Expressions containing `evaluateThreatIntelligence` require a Cloud
5085 # Armor Enterprise subscription and are not supported in Edge Policies
5086 # nor in Regional Policies. Expressions containing
5087 # `evaluatePreconfiguredExpr(&#x27;sourceiplist-*&#x27;)` require a Cloud Armor
5088 # Enterprise subscription and are only supported in Global Security
5089 # Policies.
5090 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5091 # are documented at https://github.com/google/cel-spec.
5092 #
5093 # Example (Comparison):
5094 #
5095 # title: &quot;Summary size limit&quot;
5096 # description: &quot;Determines if a summary is less than 100 chars&quot;
5097 # expression: &quot;document.summary.size() &lt; 100&quot;
5098 #
5099 # Example (Equality):
5100 #
5101 # title: &quot;Requestor is owner&quot;
5102 # description: &quot;Determines if requestor is the document owner&quot;
5103 # expression: &quot;document.owner == request.auth.claims.email&quot;
5104 #
5105 # Example (Logic):
5106 #
5107 # title: &quot;Public documents&quot;
5108 # description: &quot;Determine whether the document should be publicly visible&quot;
5109 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5110 #
5111 # Example (Data Manipulation):
5112 #
5113 # title: &quot;Notification string&quot;
5114 # description: &quot;Create a notification string with a timestamp.&quot;
5115 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5116 #
5117 # The exact variables and functions that may be referenced within an expression
5118 # are determined by the service that evaluates it. See the service
5119 # documentation for additional information.
5120 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5121 # describes the expression, e.g. when hovered over it in a UI.
5122 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5123 # syntax.
5124 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5125 # reporting, e.g. a file name and a position in the file.
5126 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5127 # its purpose. This can be used e.g. in UIs which allow to enter the
5128 # expression.
5129 },
5130 &quot;exprOptions&quot;: { # The configuration options available when specifying a user defined
5131 # CEVAL expression (i.e., &#x27;expr&#x27;).
5132 &quot;recaptchaOptions&quot;: { # reCAPTCHA configuration options to be applied for the rule. If the
5133 # rule does not evaluate reCAPTCHA tokens, this field has no effect.
5134 &quot;actionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
5135 # action-tokens. The provided site keys need to be created from
5136 # reCAPTCHA API under the same project where the security policy is
5137 # created.
5138 &quot;A String&quot;,
5139 ],
5140 &quot;sessionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
5141 # session-tokens. The provided site keys need to be created from
5142 # reCAPTCHA API under the same project where the security policy is
5143 # created.
5144 &quot;A String&quot;,
5145 ],
5146 },
5147 },
5148 &quot;versionedExpr&quot;: &quot;A String&quot;, # Preconfigured versioned expression.
5149 # If this field is specified, config must also be specified.
5150 # Available preconfigured expressions along with their requirements are:
5151 # SRC_IPS_V1 - must specify the corresponding src_ip_range field in
5152 # config.
5153 },
5154 &quot;networkMatch&quot;: { # Represents a match condition that incoming network traffic is evaluated # A match condition that incoming packets are evaluated against for
5155 # CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
5156 # &#x27;action&#x27; is enforced.
5157 #
5158 # The match criteria for a rule consists of built-in match fields (like
5159 # &#x27;srcIpRanges&#x27;) and potentially multiple user-defined match fields
5160 # (&#x27;userDefinedFields&#x27;).
5161 #
5162 # Field values may be extracted directly from the packet or derived from it
5163 # (e.g. &#x27;srcRegionCodes&#x27;). Some fields may not be present in every packet
5164 # (e.g. &#x27;srcPorts&#x27;). A user-defined field is only present if the base
5165 # header is found in the packet and the entire field is in bounds.
5166 #
5167 # Each match field may specify which values can match it, listing one or
5168 # more ranges, prefixes, or exact values that are considered a match for
5169 # the field. A field value must be present in order to match a specified
5170 # match field. If no match values are specified for a match field, then any
5171 # field value is considered to match it, and it&#x27;s not required to be
5172 # present. For strings specifying &#x27;*&#x27; is also equivalent to match all.
5173 #
5174 # For a packet to match a rule, all specified match fields must match the
5175 # corresponding field values derived from the packet.
5176 #
5177 # Example:
5178 #
5179 # networkMatch:
5180 # srcIpRanges:
5181 # - &quot;192.0.2.0/24&quot;
5182 # - &quot;198.51.100.0/24&quot;
5183 # userDefinedFields:
5184 # - name: &quot;ipv4_fragment_offset&quot;
5185 # values:
5186 # - &quot;1-0x1fff&quot;
5187 #
5188 # The above match condition matches packets with a source IP in
5189 # 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
5190 # &quot;ipv4_fragment_offset&quot; with a value between 1 and 0x1fff inclusive.
5191 # against.
5192 &quot;destIpRanges&quot;: [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text
5193 # format.
5194 &quot;A String&quot;,
5195 ],
5196 &quot;destPorts&quot;: [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
5197 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
5198 &quot;A String&quot;,
5199 ],
5200 &quot;ipProtocols&quot;: [ # IPv4 protocol / IPv6 next header (after extension headers). Each
5201 # element can be an 8-bit unsigned decimal number (e.g. &quot;6&quot;), range (e.g.
5202 # &quot;253-254&quot;), or one of the following protocol names: &quot;tcp&quot;, &quot;udp&quot;,
5203 # &quot;icmp&quot;, &quot;esp&quot;, &quot;ah&quot;, &quot;ipip&quot;, or &quot;sctp&quot;.
5204 &quot;A String&quot;,
5205 ],
5206 &quot;srcAsns&quot;: [ # BGP Autonomous System Number associated with the source IP address.
5207 42,
5208 ],
5209 &quot;srcIpRanges&quot;: [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
5210 &quot;A String&quot;,
5211 ],
5212 &quot;srcPorts&quot;: [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
5213 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
5214 &quot;A String&quot;,
5215 ],
5216 &quot;srcRegionCodes&quot;: [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source
5217 # IP address.
5218 &quot;A String&quot;,
5219 ],
5220 &quot;userDefinedFields&quot;: [ # User-defined fields. Each element names a defined field and lists the
5221 # matching values for that field.
5222 {
5223 &quot;name&quot;: &quot;A String&quot;, # Name of the user-defined field, as given in the definition.
5224 &quot;values&quot;: [ # Matching values of the field. Each element can be a 32-bit unsigned
5225 # decimal or hexadecimal (starting with &quot;0x&quot;) number (e.g. &quot;64&quot;) or
5226 # range (e.g. &quot;0x400-0x7ff&quot;).
5227 &quot;A String&quot;,
5228 ],
5229 },
5230 ],
5231 },
5232 &quot;preconfiguredWafConfig&quot;: { # Preconfigured WAF configuration to be applied for the rule. If the rule
5233 # does not evaluate preconfigured WAF rules, i.e., if
5234 # evaluatePreconfiguredWaf() is not used, this field will have no effect.
5235 &quot;exclusions&quot;: [ # A list of exclusions to apply during preconfigured WAF evaluation.
5236 {
5237 &quot;requestBodiesToExclude&quot;: [ # A list of request body fields to be excluded from inspection during
5238 # preconfigured WAF evaluation.
5239 {
5240 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
5241 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
5242 },
5243 ],
5244 &quot;requestCookiesToExclude&quot;: [ # A list of request cookie names whose value will be excluded from
5245 # inspection during preconfigured WAF evaluation.
5246 {
5247 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
5248 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
5249 },
5250 ],
5251 &quot;requestHeadersToExclude&quot;: [ # A list of request header names whose value will be excluded from
5252 # inspection during preconfigured WAF evaluation.
5253 {
5254 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
5255 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
5256 },
5257 ],
5258 &quot;requestQueryParamsToExclude&quot;: [ # A list of request query parameter names whose value will be excluded
5259 # from inspection during preconfigured WAF evaluation. Note that the
5260 # parameter can be in the query string or in the POST body.
5261 {
5262 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
5263 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
5264 },
5265 ],
5266 &quot;requestUrisToExclude&quot;: [ # A list of request URIs from the request line to be excluded from
5267 # inspection during preconfigured WAF evaluation. When specifying this
5268 # field, the query or fragment part should be excluded.
5269 {
5270 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
5271 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
5272 },
5273 ],
5274 &quot;targetRuleIds&quot;: [ # A list of target rule IDs under the WAF rule set to apply the
5275 # preconfigured WAF exclusion. If omitted, it refers to all the rule
5276 # IDs under the WAF rule set.
5277 &quot;A String&quot;,
5278 ],
5279 &quot;targetRuleSet&quot;: &quot;A String&quot;, # Target WAF rule set to apply the preconfigured WAF exclusion.
5280 },
5281 ],
5282 },
5283 &quot;preview&quot;: True or False, # If set to true, the specified action is not enforced.
5284 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
5285 # must be a positive value between 0 and 2147483647.
5286 # Rules are evaluated from highest to lowest priority where 0 is the
5287 # highest priority and 2147483647 is the lowest priority.
5288 &quot;rateLimitOptions&quot;: { # Must be specified if the action is &quot;rate_based_ban&quot; or &quot;throttle&quot; or
5289 # &quot;fairshare&quot;. Cannot be specified for any other actions.
5290 &quot;banDurationSec&quot;: 42, # Can only be specified if the action for the rule is
5291 # &quot;rate_based_ban&quot;. If specified, determines the time (in seconds)
5292 # the traffic will continue to be banned by the rate limit after the
5293 # rate falls below the threshold.
5294 &quot;banThreshold&quot;: { # Can only be specified if the action for the rule is
5295 # &quot;rate_based_ban&quot;. If specified, the key will be banned for the
5296 # configured &#x27;ban_duration_sec&#x27; when the number of requests that exceed
5297 # the &#x27;rate_limit_threshold&#x27; also exceed this &#x27;ban_threshold&#x27;.
5298 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
5299 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
5300 },
5301 &quot;conformAction&quot;: &quot;A String&quot;, # Action to take for requests that are under the configured rate limit
5302 # threshold. Valid option is &quot;allow&quot; only.
5303 &quot;enforceOnKey&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
5304 # values are:
5305 #
5306 # - ALL: A single rate limit threshold is applied to all
5307 # the requests matching this rule. This is the default value if
5308 # &quot;enforceOnKey&quot; is not configured.
5309 # - IP: The source IP address of
5310 # the request is the key. Each IP has this limit enforced
5311 # separately.
5312 # - HTTP_HEADER: The value of the HTTP
5313 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
5314 # value is truncated to the first 128 bytes of the header value. If no
5315 # such header is present in the request, the key type defaults toALL.
5316 # - XFF_IP: The first IP address (i.e. the
5317 # originating client IP address) specified in the list of IPs under
5318 # X-Forwarded-For HTTP header. If no such header is present or the value
5319 # is not a valid IP, the key defaults to the source IP address of
5320 # the request i.e. key type IP.
5321 # - HTTP_COOKIE: The value of the HTTP
5322 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
5323 # value is truncated to the first 128 bytes of the cookie value. If no
5324 # such cookie is present in the request, the key type defaults toALL.
5325 # - HTTP_PATH: The URL path of the HTTP request. The key
5326 # value is truncated to the first 128 bytes.
5327 # - SNI: Server name indication in the TLS session of the
5328 # HTTPS request. The key value is truncated to the first 128 bytes. The
5329 # key type defaults to ALL on a HTTP session.
5330 # - REGION_CODE: The country/region from which the request
5331 # originates.
5332 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
5333 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
5334 # key type defaults to ALL.
5335 # - USER_IP: The IP address of the originating client,
5336 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
5337 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration or
5338 # an IP address cannot be resolved from it, the key type defaults toIP.
5339 #
5340 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
5341 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
5342 # key type defaults to ALL.
5343 # For &quot;fairshare&quot; action, this value is limited to ALL i.e. a single rate
5344 # limit threshold is enforced for all the requests matching the rule.
5345 &quot;enforceOnKeyConfigs&quot;: [ # If specified, any combination of values of
5346 # enforce_on_key_type/enforce_on_key_name is treated as the key on which
5347 # ratelimit threshold/action is enforced. You can specify up to 3
5348 # enforce_on_key_configs. If enforce_on_key_configs is specified,
5349 # enforce_on_key must not be specified.
5350 {
5351 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
5352 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the
5353 # key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is
5354 # taken as the key value.
5355 &quot;enforceOnKeyType&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
5356 # values are:
5357 #
5358 # - ALL: A single rate limit threshold is applied to all
5359 # the requests matching this rule. This is the default value if
5360 # &quot;enforceOnKeyConfigs&quot; is not configured.
5361 # - IP: The source IP address of
5362 # the request is the key. Each IP has this limit enforced
5363 # separately.
5364 # - HTTP_HEADER: The value of the HTTP
5365 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
5366 # value is truncated to the first 128 bytes of the header value. If no
5367 # such header is present in the request, the key type defaults toALL.
5368 # - XFF_IP: The first IP address (i.e. the
5369 # originating client IP address) specified in the list of IPs under
5370 # X-Forwarded-For HTTP header. If no such header is present or the
5371 # value is not a valid IP, the key defaults to the source IP address of
5372 # the request i.e. key type IP.
5373 # - HTTP_COOKIE: The value of the HTTP
5374 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
5375 # value is truncated to the first 128 bytes of the cookie value. If no
5376 # such cookie is present in the request, the key type defaults toALL.
5377 # - HTTP_PATH: The URL path of the HTTP request. The key
5378 # value is truncated to the first 128 bytes.
5379 # - SNI: Server name indication in the TLS session of
5380 # the HTTPS request. The key value is truncated to the first 128 bytes.
5381 # The key type defaults to ALL on a HTTP session.
5382 # - REGION_CODE: The country/region from which the
5383 # request originates.
5384 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
5385 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
5386 # key type defaults to ALL.
5387 # - USER_IP: The IP address of the originating client,
5388 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
5389 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration
5390 # or an IP address cannot be resolved from it, the key type defaults toIP.
5391 #
5392 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
5393 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
5394 # key type defaults to ALL.
5395 },
5396 ],
5397 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
5398 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the key
5399 # value.
5400 # HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key
5401 # value.
5402 &quot;exceedAction&quot;: &quot;A String&quot;, # Action to take for requests that are above the configured rate limit
5403 # threshold, to either deny with a specified HTTP response code, or
5404 # redirect to a different endpoint.
5405 # Valid options are `deny(STATUS)`, where valid values for
5406 # `STATUS` are 403, 404, 429, and 502, and
5407 # `redirect`, where the redirect parameters come from
5408 # `exceedRedirectOptions` below.
5409 # The `redirect` action is only supported in Global Security Policies of
5410 # type CLOUD_ARMOR.
5411 &quot;exceedActionRpcStatus&quot;: { # Simplified google.rpc.Status type (omitting details). # Specified gRPC response status for proxyless gRPC requests that are
5412 # above the configured rate limit threshold
5413 &quot;code&quot;: 42, # The status code, which should be an enum value of
5414 # google.rpc.Code.
5415 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English.
5416 },
5417 &quot;exceedRedirectOptions&quot;: { # Parameters defining the redirect action that is used as the exceed
5418 # action. Cannot be specified if the exceed action is not redirect.
5419 # This field is only supported in Global Security Policies of type
5420 # CLOUD_ARMOR.
5421 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
5422 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
5423 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
5424 #
5425 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
5426 # challenge assessment.
5427 # - EXTERNAL_302: redirect to a different URL via a 302
5428 # response.
5429 },
5430 &quot;rateLimitThreshold&quot;: { # Threshold at which to begin ratelimiting.
5431 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
5432 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
5433 },
5434 },
5435 &quot;redirectOptions&quot;: { # Parameters defining the redirect action. Cannot be specified for any
5436 # other actions.
5437 # This field is only supported in Global Security Policies of type
5438 # CLOUD_ARMOR.
5439 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
5440 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
5441 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
5442 #
5443 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
5444 # challenge assessment.
5445 # - EXTERNAL_302: redirect to a different URL via a 302
5446 # response.
5447 },
5448 &quot;redirectTarget&quot;: &quot;A String&quot;, # This must be specified for redirect actions. Cannot be specified for any
5449 # other actions.
5450 &quot;ruleManagedProtectionTier&quot;: &quot;A String&quot;, # Output only. [Output Only] The minimum Cloud Armor subscription required for this
5451 # rule.
5452 # [Deprecated] Use requiredManagedProtectionTiers instead.
5453 &quot;ruleNumber&quot;: &quot;A String&quot;, # Identifier for the rule. This is only unique within the given security
5454 # policy. This can only be set during rule creation, if rule number is not
5455 # specified it will be generated by the server.
5456 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall security
5457 # policy rule.
5458 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
5459 # allows you to control which network&#x27;s VMs get this rule. If this field
5460 # is left blank, all VMs within the organization will receive the rule.
5461 #
5462 # This field may only be specified when versioned_expr is set to FIREWALL.
5463 &quot;A String&quot;,
5464 ],
5465 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
5466 # applied with this rule.
5467 &quot;A String&quot;,
5468 ],
5469 },
5470 ],
5471 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
5472 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5473 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the organization security policy. The name should be
5474 # unique in the organization in which the security policy is created. This
5475 # should only be used when SecurityPolicyType is CLOUD_ARMOR.
5476 # The name must be 1-63 characters long, and comply with
5477 # https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63
5478 # characters long and match the regular expression
5479 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
5480 # lowercase letter, and all following characters must be a dash, lowercase
5481 # letter, or digit, except the last character, which cannot be a dash.
5482 &quot;type&quot;: &quot;A String&quot;, # The type indicates the intended use of the security policy.
5483 #
5484 # - CLOUD_ARMOR: Cloud Armor backend security policies can
5485 # be configured to filter incoming HTTP requests targeting backend services.
5486 # They filter requests before they hit the origin servers.
5487 # - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can
5488 # be configured to filter incoming HTTP requests targeting backend services
5489 # (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage).
5490 # They filter requests before the request is served from Google&#x27;s cache.
5491 # - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor
5492 # internal service policies can be configured to filter HTTP requests
5493 # targeting services managed by Traffic Director in a service mesh. They
5494 # filter requests before the request is served from the application.
5495 #
5496 # - CLOUD_ARMOR_NETWORK: Cloud Armor network policies
5497 # can be configured to filter packets targeting network load balancing
5498 # resources such as backend services, target pools, target instances, and
5499 # instances with external IPs. They filter requests before the request is
5500 # served from the application.
5501 #
5502 #
5503 # This field can be set only at resource creation time.
5504 &quot;userDefinedFields&quot;: [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A
5505 # user-defined field consists of up to 4 bytes extracted from a fixed offset
5506 # in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an
5507 # optional mask to select certain bits. Rules may then specify matching
5508 # values for these fields.
5509 #
5510 # Example:
5511 #
5512 # userDefinedFields:
5513 # - name: &quot;ipv4_fragment_offset&quot;
5514 # base: IPV4
5515 # offset: 6
5516 # size: 2
5517 # mask: &quot;0x1fff&quot;
5518 {
5519 &quot;base&quot;: &quot;A String&quot;, # The base relative to which &#x27;offset&#x27; is measured. Possible values are:
5520 #
5521 # - IPV4: Points to the beginning of the IPv4 header.
5522 # - IPV6: Points to the beginning of the IPv6 header.
5523 # - TCP: Points to the beginning of the TCP header, skipping
5524 # over any IPv4 options or IPv6 extension headers. Not present for
5525 # non-first fragments.
5526 # - UDP: Points to the beginning of the UDP header, skipping
5527 # over any IPv4 options or IPv6 extension headers. Not present for
5528 # non-first fragments.
5529 #
5530 #
5531 # required
5532 &quot;mask&quot;: &quot;A String&quot;, # If specified, apply this mask (bitwise AND) to the field to ignore bits
5533 # before matching. Encoded as a hexadecimal number (starting with &quot;0x&quot;).
5534 # The last byte of the field (in network byte order) corresponds to the
5535 # least significant byte of the mask.
5536 &quot;name&quot;: &quot;A String&quot;, # The name of this field. Must be unique within the policy.
5537 &quot;offset&quot;: 42, # Offset of the first byte of the field (in network byte order) relative to
5538 # &#x27;base&#x27;.
5539 &quot;size&quot;: 42, # Size of the field in bytes. Valid values: 1-4.
5540 },
5541 ],
5542 },
5543 ],
5544 }</pre>
5545 </div>
5546
5547 <div class="method">
5548 <code class="details" id="getHealth">getHealth(project, backendService, body=None, x__xgafv=None)</code>
5549 <pre>Gets the most recent health check results for this
5550 BackendService.
5551
5552 Example request body:
5553
5554 {
5555 &quot;group&quot;: &quot;/zones/us-east1-b/instanceGroups/lb-backend-example&quot;
5556 }
5557
5558 Args:
5559 project: string, A parameter (required)
5560 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
5561 body: object, The request body.
5562 The object takes the form of:
5563
5564 {
5565 &quot;group&quot;: &quot;A String&quot;, # A URI referencing one of the instance groups or network endpoint groups
5566 # listed in the backend service.
5567 }
5568
5569 x__xgafv: string, V1 error format.
5570 Allowed values
5571 1 - v1 error format
5572 2 - v2 error format
5573
5574 Returns:
5575 An object of the form:
5576
5577 {
5578 &quot;annotations&quot;: { # Metadata defined as annotations on the network endpoint group.
5579 &quot;a_key&quot;: &quot;A String&quot;,
5580 },
5581 &quot;healthStatus&quot;: [ # Health state of the backend instances or endpoints in requested instance or
5582 # network endpoint group, determined based on configured health checks.
5583 {
5584 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
5585 &quot;a_key&quot;: &quot;A String&quot;,
5586 },
5587 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
5588 # instance.
5589 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
5590 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
5591 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
5592 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
5593 # rule&#x27;s IP address assigned to this instance. For other types of load
5594 # balancing, the field indicates VM internal ip.
5595 &quot;ipv6Address&quot;: &quot;A String&quot;,
5596 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
5597 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
5598 # health-checked.
5599 &quot;weight&quot;: &quot;A String&quot;,
5600 &quot;weightError&quot;: &quot;A String&quot;,
5601 },
5602 ],
5603 &quot;kind&quot;: &quot;compute#backendServiceGroupHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend
5604 # services.
5605 }</pre>
5606 </div>
5607
5608 <div class="method">
5609 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
5610 <pre>Gets the access control policy for a resource. May be empty if no such
5611 policy or resource exists.
5612
5613 Args:
5614 project: string, Project ID for this request. (required)
5615 resource: string, Name or id of the resource for this request. (required)
5616 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
5617 x__xgafv: string, V1 error format.
5618 Allowed values
5619 1 - v1 error format
5620 2 - v2 error format
5621
5622 Returns:
5623 An object of the form:
5624
5625 { # An Identity and Access Management (IAM) policy, which specifies access
5626 # controls for Google Cloud resources.
5627 #
5628 #
5629 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
5630 # `members`, or principals, to a single `role`. Principals can be user
5631 # accounts, service accounts, Google groups, and domains (such as G Suite). A
5632 # `role` is a named list of permissions; each `role` can be an IAM predefined
5633 # role or a user-created custom role.
5634 #
5635 # For some types of Google Cloud resources, a `binding` can also specify a
5636 # `condition`, which is a logical expression that allows access to a resource
5637 # only if the expression evaluates to `true`. A condition can add constraints
5638 # based on attributes of the request, the resource, or both. To learn which
5639 # resources support conditions in their IAM policies, see the
5640 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5641 #
5642 # **JSON example:**
5643 #
5644 # ```
5645 # {
5646 # &quot;bindings&quot;: [
5647 # {
5648 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
5649 # &quot;members&quot;: [
5650 # &quot;user:[email protected]&quot;,
5651 # &quot;group:[email protected]&quot;,
5652 # &quot;domain:google.com&quot;,
5653 # &quot;serviceAccount:[email protected]&quot;
5654 # ]
5655 # },
5656 # {
5657 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
5658 # &quot;members&quot;: [
5659 # &quot;user:[email protected]&quot;
5660 # ],
5661 # &quot;condition&quot;: {
5662 # &quot;title&quot;: &quot;expirable access&quot;,
5663 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
5664 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
5665 # }
5666 # }
5667 # ],
5668 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
5669 # &quot;version&quot;: 3
5670 # }
5671 # ```
5672 #
5673 # **YAML example:**
5674 #
5675 # ```
5676 # bindings:
5677 # - members:
5678 # - user:[email protected]
5679 # - group:[email protected]
5680 # - domain:google.com
5681 # - serviceAccount:[email protected]
5682 # role: roles/resourcemanager.organizationAdmin
5683 # - members:
5684 # - user:[email protected]
5685 # role: roles/resourcemanager.organizationViewer
5686 # condition:
5687 # title: expirable access
5688 # description: Does not grant access after Sep 2020
5689 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
5690 # etag: BwWWja0YfJA=
5691 # version: 3
5692 # ```
5693 #
5694 # For a description of IAM and its features, see the
5695 # [IAM documentation](https://cloud.google.com/iam/docs/).
5696 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
5697 { # Specifies the audit configuration for a service.
5698 # The configuration determines which permission types are logged, and what
5699 # identities, if any, are exempted from logging.
5700 # An AuditConfig must have one or more AuditLogConfigs.
5701 #
5702 # If there are AuditConfigs for both `allServices` and a specific service,
5703 # the union of the two AuditConfigs is used for that service: the log_types
5704 # specified in each AuditConfig are enabled, and the exempted_members in each
5705 # AuditLogConfig are exempted.
5706 #
5707 # Example Policy with multiple AuditConfigs:
5708 #
5709 # {
5710 # &quot;audit_configs&quot;: [
5711 # {
5712 # &quot;service&quot;: &quot;allServices&quot;,
5713 # &quot;audit_log_configs&quot;: [
5714 # {
5715 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5716 # &quot;exempted_members&quot;: [
5717 # &quot;user:[email protected]&quot;
5718 # ]
5719 # },
5720 # {
5721 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5722 # },
5723 # {
5724 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
5725 # }
5726 # ]
5727 # },
5728 # {
5729 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
5730 # &quot;audit_log_configs&quot;: [
5731 # {
5732 # &quot;log_type&quot;: &quot;DATA_READ&quot;
5733 # },
5734 # {
5735 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
5736 # &quot;exempted_members&quot;: [
5737 # &quot;user:[email protected]&quot;
5738 # ]
5739 # }
5740 # ]
5741 # }
5742 # ]
5743 # }
5744 #
5745 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
5746 # logging. It also exempts `[email protected]` from DATA_READ logging, and
5747 # `[email protected]` from DATA_WRITE logging.
5748 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
5749 { # Provides the configuration for logging a type of permissions.
5750 # Example:
5751 #
5752 # {
5753 # &quot;audit_log_configs&quot;: [
5754 # {
5755 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5756 # &quot;exempted_members&quot;: [
5757 # &quot;user:[email protected]&quot;
5758 # ]
5759 # },
5760 # {
5761 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5762 # }
5763 # ]
5764 # }
5765 #
5766 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
5767 # [email protected] from DATA_READ logging.
5768 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
5769 # permission.
5770 # Follows the same format of Binding.members.
5771 &quot;A String&quot;,
5772 ],
5773 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
5774 },
5775 ],
5776 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
5777 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
5778 # `allServices` is a special value that covers all services.
5779 },
5780 ],
5781 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
5782 # may specify a `condition` that determines how and when the `bindings` are
5783 # applied. Each of the `bindings` must contain at least one principal.
5784 #
5785 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
5786 # of these principals can be Google groups. Each occurrence of a principal
5787 # counts towards these limits. For example, if the `bindings` grant 50
5788 # different roles to `user:[email protected]`, and not to any other
5789 # principal, then you can add another 1,450 principals to the `bindings` in
5790 # the `Policy`.
5791 { # Associates `members`, or principals, with a `role`.
5792 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
5793 #
5794 # If the condition evaluates to `true`, then this binding applies to the
5795 # current request.
5796 #
5797 # If the condition evaluates to `false`, then this binding does not apply to
5798 # the current request. However, a different role binding might grant the same
5799 # role to one or more of the principals in this binding.
5800 #
5801 # To learn which resources support conditions in their IAM policies, see the
5802 # [IAM
5803 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5804 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5805 # are documented at https://github.com/google/cel-spec.
5806 #
5807 # Example (Comparison):
5808 #
5809 # title: &quot;Summary size limit&quot;
5810 # description: &quot;Determines if a summary is less than 100 chars&quot;
5811 # expression: &quot;document.summary.size() &lt; 100&quot;
5812 #
5813 # Example (Equality):
5814 #
5815 # title: &quot;Requestor is owner&quot;
5816 # description: &quot;Determines if requestor is the document owner&quot;
5817 # expression: &quot;document.owner == request.auth.claims.email&quot;
5818 #
5819 # Example (Logic):
5820 #
5821 # title: &quot;Public documents&quot;
5822 # description: &quot;Determine whether the document should be publicly visible&quot;
5823 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5824 #
5825 # Example (Data Manipulation):
5826 #
5827 # title: &quot;Notification string&quot;
5828 # description: &quot;Create a notification string with a timestamp.&quot;
5829 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5830 #
5831 # The exact variables and functions that may be referenced within an expression
5832 # are determined by the service that evaluates it. See the service
5833 # documentation for additional information.
5834 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5835 # describes the expression, e.g. when hovered over it in a UI.
5836 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5837 # syntax.
5838 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5839 # reporting, e.g. a file name and a position in the file.
5840 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5841 # its purpose. This can be used e.g. in UIs which allow to enter the
5842 # expression.
5843 },
5844 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
5845 # `members` can have the following values:
5846 #
5847 # * `allUsers`: A special identifier that represents anyone who is
5848 # on the internet; with or without a Google account.
5849 #
5850 # * `allAuthenticatedUsers`: A special identifier that represents anyone
5851 # who is authenticated with a Google account or a service account.
5852 # Does not include identities that come from external identity providers
5853 # (IdPs) through identity federation.
5854 #
5855 # * `user:{emailid}`: An email address that represents a specific Google
5856 # account. For example, `[email protected]` .
5857 #
5858 #
5859 # * `serviceAccount:{emailid}`: An email address that represents a Google
5860 # service account. For example,
5861 # `[email protected]`.
5862 #
5863 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
5864 # identifier for a
5865 # [Kubernetes service
5866 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
5867 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
5868 #
5869 # * `group:{emailid}`: An email address that represents a Google group.
5870 # For example, `[email protected]`.
5871 #
5872 #
5873 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
5874 # users of that domain. For example, `google.com` or `example.com`.
5875 #
5876 #
5877 #
5878 #
5879 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5880 # A single identity in a workforce identity pool.
5881 #
5882 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
5883 # All workforce identities in a group.
5884 #
5885 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5886 # All workforce identities with a specific attribute value.
5887 #
5888 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
5889 # All identities in a workforce identity pool.
5890 #
5891 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
5892 # A single identity in a workload identity pool.
5893 #
5894 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
5895 # A workload identity pool group.
5896 #
5897 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5898 # All identities in a workload identity pool with a certain attribute.
5899 #
5900 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
5901 # All identities in a workload identity pool.
5902 #
5903 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
5904 # identifier) representing a user that has been recently deleted. For
5905 # example, `[email protected]?uid=123456789012345678901`. If the user is
5906 # recovered, this value reverts to `user:{emailid}` and the recovered user
5907 # retains the role in the binding.
5908 #
5909 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
5910 # unique identifier) representing a service account that has been recently
5911 # deleted. For example,
5912 # `[email protected]?uid=123456789012345678901`.
5913 # If the service account is undeleted, this value reverts to
5914 # `serviceAccount:{emailid}` and the undeleted service account retains the
5915 # role in the binding.
5916 #
5917 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
5918 # identifier) representing a Google group that has been recently
5919 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
5920 # the group is recovered, this value reverts to `group:{emailid}` and the
5921 # recovered group retains the role in the binding.
5922 #
5923 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5924 # Deleted single identity in a workforce identity pool. For example,
5925 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
5926 &quot;A String&quot;,
5927 ],
5928 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
5929 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
5930 #
5931 # For an overview of the IAM roles and permissions, see the
5932 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
5933 # a list of the available pre-defined roles, see
5934 # [here](https://cloud.google.com/iam/docs/understanding-roles).
5935 },
5936 ],
5937 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
5938 # prevent simultaneous updates of a policy from overwriting each other.
5939 # It is strongly suggested that systems make use of the `etag` in the
5940 # read-modify-write cycle to perform policy updates in order to avoid race
5941 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
5942 # systems are expected to put that etag in the request to `setIamPolicy` to
5943 # ensure that their change will be applied to the same version of the policy.
5944 #
5945 # **Important:** If you use IAM Conditions, you must include the `etag` field
5946 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5947 # you to overwrite a version `3` policy with a version `1` policy, and all of
5948 # the conditions in the version `3` policy are lost.
5949 &quot;version&quot;: 42, # Specifies the format of the policy.
5950 #
5951 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
5952 # are rejected.
5953 #
5954 # Any operation that affects conditional role bindings must specify version
5955 # `3`. This requirement applies to the following operations:
5956 #
5957 # * Getting a policy that includes a conditional role binding
5958 # * Adding a conditional role binding to a policy
5959 # * Changing a conditional role binding in a policy
5960 # * Removing any role binding, with or without a condition, from a policy
5961 # that includes conditions
5962 #
5963 # **Important:** If you use IAM Conditions, you must include the `etag` field
5964 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5965 # you to overwrite a version `3` policy with a version `1` policy, and all of
5966 # the conditions in the version `3` policy are lost.
5967 #
5968 # If a policy does not include any conditions, operations on that policy may
5969 # specify any valid version or leave the field unset.
5970 #
5971 # To learn which resources support conditions in their IAM policies, see the
5972 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5973 }</pre>
5974 </div>
5975
5976 <div class="method">
5977 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
5978 <pre>Creates a BackendService resource in the specified project using
5979 the data included in the request. For more information, see
5980 Backend services overview.
5981
5982 Args:
5983 project: string, Project ID for this request. (required)
5984 body: object, The request body.
5985 The object takes the form of:
5986
5987 { # Represents a Backend Service resource.
5988 #
5989 # A backend service defines how Google Cloud load balancers distribute traffic.
5990 # The backend service configuration contains a set of values, such as the
5991 # protocol used to connect to backends, various distribution and session
5992 # settings, health checks, and timeouts. These settings provide fine-grained
5993 # control over how your load balancer behaves. Most of the settings have
5994 # default values that allow for easy configuration if you need to get started
5995 # quickly.
5996 #
5997 # Backend services in Google Compute Engine can be either regionally or
5998 # globally scoped.
5999 #
6000 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
6001 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
6002 #
6003 # For more information, seeBackend
6004 # Services.
6005 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
6006 # Load Balancers and Traffic Director and requires
6007 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
6008 #
6009 # If set to 0, the cookie is non-persistent and lasts only until
6010 # the end of the browser session (or equivalent). The maximum allowed value
6011 # is two weeks (1,209,600).
6012 #
6013 # Not supported when the backend service is referenced by a URL map that is
6014 # bound to target gRPC proxy that has validateForProxyless field set to true.
6015 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
6016 # load balancing scheme set to INTERNAL_SELF_MANAGED.
6017 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
6018 { # Message containing information of one individual backend.
6019 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
6020 # handle additional traffic or is fully loaded. For usage guidelines, see
6021 # Connection balancing mode.
6022 #
6023 # Backends must use compatible balancing modes. For more information, see
6024 # Supported balancing modes and target capacity settings and
6025 # Restrictions and guidance for instance groups.
6026 #
6027 # Note: Currently, if you use the API to configure incompatible balancing
6028 # modes, the configuration might be accepted even though it has no impact
6029 # and is ignored. Specifically, Backend.maxUtilization is ignored when
6030 # Backend.balancingMode is RATE. In the future, this incompatible combination
6031 # will be rejected.
6032 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
6033 # mode.
6034 # The default value is 1, which means the group serves up to
6035 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
6036 # completely drained, offering 0% of its available capacity. The valid ranges
6037 # are 0.0 and [0.1,1.0].
6038 # You cannot configure a setting larger than 0 and smaller than0.1.
6039 # You cannot configure a setting of 0 when there is only one
6040 # backend attached to the backend service.
6041 #
6042 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
6043 # internet NEGs, regional serverless NEGs, and PSC NEGs.
6044 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
6045 # BalancingMode.
6046 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
6047 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
6048 # Monitoring, but is not used for load balancing.
6049 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
6050 # balancing mode. The valid range is [0.0, 1.0].
6051 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6052 # long and match the regular expression
6053 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6054 # first character must be a lowercase letter, and all following
6055 # characters must be a dash, period, underscore, lowercase letter, or
6056 # digit, except the last character, which cannot be a dash, period, or
6057 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6058 # field can only be used for a global or regional backend service with the
6059 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6060 },
6061 ],
6062 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6063 # create the resource.
6064 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
6065 # failover backend can be configured for a given BackendService.
6066 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
6067 # group or network endpoint
6068 # group (NEG) resource. To determine what types of backends a load
6069 # balancer supports, see the [Backend services
6070 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
6071 #
6072 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
6073 # or NEG. Partial URLs are not supported.
6074 #
6075 # If haPolicy is specified, backends must refer to NEG resources of type
6076 # GCE_VM_IP.
6077 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6078 # guidelines, seeConnection
6079 # balancing mode and Utilization
6080 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
6081 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6082 # guidelines, seeConnection
6083 # balancing mode and Utilization
6084 # balancing mode.
6085 #
6086 # Not available if the backend&#x27;s balancingMode isRATE.
6087 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
6088 # For usage guidelines, seeConnection
6089 # balancing mode and Utilization
6090 # balancing mode.
6091 #
6092 # Not available if the backend&#x27;s balancingMode isRATE.
6093 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
6094 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
6095 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
6096 # Not available if backend&#x27;s balancingMode is RATE
6097 # or CONNECTION.
6098 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
6099 # Not available if backend&#x27;s balancingMode is RATE
6100 # or CONNECTION.
6101 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
6102 # usage guidelines, seeRate
6103 # balancing mode and Utilization
6104 # balancing mode.
6105 #
6106 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6107 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6108 # guidelines, seeRate
6109 # balancing mode and Utilization
6110 # balancing mode.
6111 #
6112 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6113 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6114 # guidelines, seeRate
6115 # balancing mode and Utilization
6116 # balancing mode.
6117 #
6118 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6119 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
6120 #
6121 # For usage guidelines, seeUtilization
6122 # balancing mode.
6123 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
6124 # the backend.
6125 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
6126 },
6127 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
6128 # sending traffic to backends with default preference. The possible values
6129 # are:
6130 #
6131 # - PREFERRED: Backends with this preference level will be
6132 # filled up to their capacity limits first, based on RTT.
6133 # - DEFAULT: If preferred backends don&#x27;t have enough
6134 # capacity, backends in this layer would be used and traffic would be
6135 # assigned based on the load balancing algorithm you use. This is the
6136 # default
6137 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
6138 # Attachment).
6139 # e.g.
6140 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
6141 # for Cloud Run service.
6142 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
6143 # for PSC Service Attachment.
6144 &quot;trafficDuration&quot;: &quot;A String&quot;,
6145 },
6146 ],
6147 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
6148 # specified load balancer types.
6149 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
6150 # Pragma or Authorization headers. Up to 5 headers can be specified.
6151 # The cache is bypassed for all cdnPolicy.cacheMode settings.
6152 { # Bypass the cache when the specified request headers are present,
6153 # e.g. Pragma or Authorization headers. Values are case insensitive.
6154 # The presence of such a header overrides the cache_mode setting.
6155 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
6156 # Values are case-insensitive.
6157 },
6158 ],
6159 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
6160 # CDN.
6161 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
6162 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
6163 &quot;A String&quot;,
6164 ],
6165 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
6166 # The name=value pair will be used in the cache key Cloud CDN generates.
6167 &quot;A String&quot;,
6168 ],
6169 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
6170 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
6171 # query_string_whitelist and query_string_blacklist. If neither is set, the
6172 # entire query string will be included. If false, the query string will be
6173 # excluded from the cache key entirely.
6174 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
6175 # parameters will be included. Either specify query_string_whitelist or
6176 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6177 # not treated as delimiters.
6178 &quot;A String&quot;,
6179 ],
6180 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
6181 # parameters will be excluded. Either specify query_string_whitelist or
6182 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6183 # not treated as delimiters.
6184 &quot;A String&quot;,
6185 ],
6186 },
6187 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
6188 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
6189 # headers to cache content. Responses without these headers will not be
6190 # cached at Google&#x27;s edge, and will require a full trip to the origin on
6191 # every request, potentially impacting performance and increasing load on
6192 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
6193 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
6194 # Warning: this may result in Cloud CDN caching private,
6195 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
6196 # including common image formats, media (video and audio), and web assets
6197 # (JavaScript and CSS). Requests and responses that are marked as
6198 # uncacheable, as well as dynamic content (including HTML), will not be
6199 # cached.
6200 #
6201 # If no value is provided for cdnPolicy.cacheMode, it defaults
6202 # to CACHE_ALL_STATIC.
6203 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
6204 # used to clamp the max-age (or Expires) value sent to the client. With
6205 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
6206 # response max-age directive, along with a &quot;public&quot; directive. For
6207 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
6208 # from the origin (if specified), or else sets the response max-age
6209 # directive to the lesser of the client_ttl and default_ttl, and also
6210 # ensures a &quot;public&quot; cache-control directive is present.
6211 # If a client TTL is not specified, a default value (1 hour) will be used.
6212 # The maximum allowed value is 31,622,400s (1 year).
6213 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
6214 # responses that do not have an existing valid TTL (max-age or s-maxage).
6215 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6216 # The value of defaultTTL cannot be set to a value greater than that of
6217 # maxTTL, but can be equal.
6218 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
6219 # will overwrite the TTL set in all responses. The maximum allowed value is
6220 # 31,622,400s (1 year), noting that infrequently accessed objects may be
6221 # evicted from the cache before the defined TTL.
6222 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
6223 # origin.
6224 # Cache directives that attempt to set a max-age or s-maxage higher than
6225 # this, or an Expires header more than maxTTL seconds in the future will
6226 # be capped at the value of maxTTL, as if it were the value of an
6227 # s-maxage Cache-Control directive.
6228 # Headers sent to the client will not be modified.
6229 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6230 # The maximum allowed value is 31,622,400s (1 year), noting that
6231 # infrequently accessed objects may be evicted from the cache before
6232 # the defined TTL.
6233 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
6234 # to apply fine-grained caching for common errors or redirects.
6235 # This can reduce the load on your origin and improve end-user
6236 # experience by reducing response latency.
6237 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
6238 # negative caching applies to responses with the specified response code
6239 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
6240 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
6241 # to all responses with the specified response code, and override any
6242 # caching headers.
6243 # By default, Cloud CDN will apply the following default TTLs to these
6244 # status codes:
6245 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
6246 # HTTP 404 (Not Found), 410 (Gone),
6247 # 451 (Unavailable For Legal Reasons): 120s
6248 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
6249 # These defaults can be overridden in negative_caching_policy.
6250 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
6251 # negative_caching must be enabled to configure negative_caching_policy.
6252 # Omitting the policy and leaving negative_caching enabled will use
6253 # Cloud CDN&#x27;s default cache TTLs.
6254 # Note that when specifying an explicit negative_caching_policy, you
6255 # should take care to specify a cache TTL for all response codes
6256 # that you wish to cache. Cloud CDN will not apply any default
6257 # negative caching when a policy exists.
6258 { # Specify CDN TTLs for response error codes.
6259 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
6260 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
6261 # specified as values, and you cannot specify a status code more than
6262 # once.
6263 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
6264 # corresponding status code.
6265 # The maximum allowed value is 1800s (30 minutes), noting that
6266 # infrequently accessed objects may be evicted from the cache before the
6267 # defined TTL.
6268 },
6269 ],
6270 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
6271 # requests into a small number of requests to the origin.
6272 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
6273 # content with the origin, or when an error is encountered when refreshing
6274 # the cache.
6275 # This setting defines the default &quot;max-stale&quot; duration for any cached
6276 # responses that do not specify a max-stale directive. Stale responses that
6277 # exceed the TTL configured here will not be served. The default limit
6278 # (max-stale) is 86400s (1 day), which will allow stale content to be
6279 # served up to this limit beyond the max-age (or s-maxage) of a cached
6280 # response.
6281 # The maximum allowed value is 604800 (1 week).
6282 # Set this to zero (0) to disable serve-while-stale.
6283 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
6284 # considered fresh. After this time period, the response will be
6285 # revalidated before being served. Defaults to 1hr (3600s). When serving
6286 # responses to signed URL requests, Cloud CDN will internally behave as
6287 # though all responses from this backend had a &quot;Cache-Control:
6288 # public, max-age=[TTL]&quot; header, regardless of any existing
6289 # Cache-Control header. The actual headers served in responses will not be
6290 # altered.
6291 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
6292 &quot;A String&quot;,
6293 ],
6294 },
6295 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
6296 # backend service.
6297 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
6298 # as a count of seconds and fractions of seconds at nanosecond
6299 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6300 # or &quot;month&quot;. Range is approximately 10,000 years.
6301 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6302 # Durations less than one second are represented with a 0
6303 # `seconds` field and a positive `nanos` field. Must be from 0
6304 # to 999,999,999 inclusive.
6305 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6306 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6307 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6308 },
6309 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
6310 # there is no limit.
6311 #
6312 # Not supported when the backend service is referenced by a URL map that is
6313 # bound to target gRPC proxy that has validateForProxyless field set to true.
6314 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
6315 # not specified, there is no limit.
6316 #
6317 # Not supported when the backend service is referenced by a URL map that is
6318 # bound to target gRPC proxy that has validateForProxyless field set to true.
6319 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
6320 # service. If not specified, there is no limit.
6321 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
6322 # This parameter is respected by both the HTTP/1.1 and HTTP/2
6323 # implementations. If not specified, there is no limit. Setting this
6324 # parameter to 1 will effectively disable keep alive.
6325 #
6326 # Not supported when the backend service is referenced by a URL map that is
6327 # bound to target gRPC proxy that has validateForProxyless field set to true.
6328 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
6329 # not specified, the default is 1.
6330 #
6331 # Not supported when the backend service is referenced by a URL map that is
6332 # bound to target gRPC proxy that has validateForProxyless field set to true.
6333 },
6334 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
6335 # the client&#x27;s Accept-Encoding header.
6336 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
6337 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
6338 # instance. For supported load balancers and protocols, as described inEnabling
6339 # connection draining.
6340 },
6341 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
6342 # tracking policy settings are only available for external passthrough
6343 # Network Load Balancers and internal passthrough Network Load Balancers.
6344 #
6345 # connectionTrackingPolicy cannot be specified with haPolicy.
6346 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
6347 # value is DEFAULT_FOR_PROTOCOL.
6348 #
6349 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
6350 # persist on unhealthy backends only for connection-oriented protocols
6351 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
6352 # Affinity is configured for 5-tuple. They do not persist forUDP.
6353 #
6354 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
6355 # the existing connections on the unhealthy backend are never persisted on
6356 # the unhealthy backend. They are always diverted to newly selected healthy
6357 # backends (unless all backends are unhealthy).
6358 #
6359 # If set to ALWAYS_PERSIST, existing connections always
6360 # persist on unhealthy backends regardless of protocol and session
6361 # affinity. It is generally not recommended to use this mode overriding the
6362 # default.
6363 #
6364 # For more details, see [Connection Persistence for Network Load
6365 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
6366 # and [Connection Persistence for Internal TCP/UDP Load
6367 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
6368 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
6369 # Balancers. This option is not available publicly.
6370 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
6371 # matching traffic (in seconds).
6372 #
6373 # For internal passthrough Network Load Balancers:
6374 #
6375 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
6376 # - It can be set only if Connection Tracking is less than 5-tuple
6377 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
6378 # Mode is PER_SESSION).
6379 #
6380 #
6381 #
6382 # For external passthrough Network Load Balancers the default is 60
6383 # seconds. This option is not available publicly.
6384 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
6385 # options:
6386 #
6387 # - PER_CONNECTION: This is the default mode. The Connection
6388 # Tracking is performed as per the Connection Key (default Hash Method) for
6389 # the specific protocol.
6390 # - PER_SESSION: The Connection Tracking is performed as per
6391 # the configured Session Affinity. It matches the configured Session
6392 # Affinity.
6393 #
6394 #
6395 #
6396 # For more details, see [Tracking Mode for Network Load
6397 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
6398 # and [Tracking Mode for Internal TCP/UDP Load
6399 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
6400 },
6401 &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
6402 # affinity based on HTTP headers, cookies or other properties. This load
6403 # balancing policy is applicable only for HTTP connections. The affinity to a
6404 # particular destination host will be lost when one or more hosts are
6405 # added/removed from the destination service. This field specifies parameters
6406 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
6407 #
6408 # This field is applicable to either:
6409 #
6410 # - A regional backend service with the service protocol set to HTTP,
6411 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6412 # INTERNAL_MANAGED.
6413 # - A global backend service with the
6414 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
6415 &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
6416 # be used as the hash key for the consistent hash load balancer. If the
6417 # cookie is not present, it will be generated. This field is applicable if
6418 # the sessionAffinity is set to HTTP_COOKIE.
6419 #
6420 # Not supported when the backend service is referenced by a URL map that is
6421 # bound to target gRPC proxy that has validateForProxyless field set to true.
6422 # for load balancing policies that use a consistent hash.
6423 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6424 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6425 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6426 # as a count of seconds and fractions of seconds at nanosecond
6427 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6428 # or &quot;month&quot;. Range is approximately 10,000 years.
6429 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6430 # Durations less than one second are represented with a 0
6431 # `seconds` field and a positive `nanos` field. Must be from 0
6432 # to 999,999,999 inclusive.
6433 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6434 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6435 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6436 },
6437 },
6438 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
6439 # applicable if the sessionAffinity is set toHEADER_FIELD.
6440 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
6441 # 1024. Larger ring sizes result in more granular load distributions. If the
6442 # number of hosts in the load balancing pool is larger than the ring size,
6443 # each host will be assigned a single virtual node.
6444 },
6445 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
6446 # text format.
6447 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
6448 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
6449 # locality_lb_policy.
6450 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
6451 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6452 # long and match the regular expression
6453 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6454 # first character must be a lowercase letter, and all following
6455 # characters must be a dash, period, underscore, lowercase letter, or
6456 # digit, except the last character, which cannot be a dash, period, or
6457 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6458 # field can only be used for a global or regional backend service with the
6459 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6460 },
6461 ],
6462 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
6463 # custom
6464 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
6465 &quot;A String&quot;,
6466 ],
6467 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
6468 # custom
6469 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
6470 &quot;A String&quot;,
6471 ],
6472 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6473 # create the resource.
6474 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
6475 # backend service with dynamic forwarding feature which together with Service
6476 # Extension allows customized and complex routing logic.
6477 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
6478 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
6479 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
6480 },
6481 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
6482 # service. Some ranges are restricted: Restricted
6483 # ranges.
6484 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
6485 },
6486 },
6487 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
6488 # this backend service.
6489 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
6490 # global external Application Load Balancer.
6491 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
6492 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
6493 #
6494 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
6495 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
6496 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
6497 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
6498 # externalManagedMigrationTestingPercentage.
6499 #
6500 # Rolling back a migration requires the states to be set in reverse order. So
6501 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
6502 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
6503 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
6504 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
6505 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
6506 # external Application Load Balancer.
6507 #
6508 # The value of this field must be in the range [0, 100].
6509 #
6510 # Session affinity options will slightly affect this routing behavior, for
6511 # more details, see:Session
6512 # Affinity.
6513 #
6514 # This value can only be set if the loadBalancingScheme in the BackendService
6515 # is set to EXTERNAL (when using the classic Application Load Balancer) and
6516 # the migration state is TEST_BY_PERCENTAGE.
6517 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
6518 # as a backup (failover) backend.
6519 # For load balancers that have configurable failover:
6520 # [Internal passthrough Network Load
6521 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6522 # and [external passthrough Network Load
6523 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6524 #
6525 # failoverPolicy cannot be specified with haPolicy.
6526 # failover:
6527 # [Internal passthrough Network Load
6528 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6529 # and [external passthrough
6530 # Network Load
6531 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6532 # On failover or failback, this field indicates whether connection draining
6533 # will be honored. Google Cloud has a fixed connection draining timeout of
6534 # 10 minutes. A setting of true terminates existing TCP
6535 # connections to the active pool during failover and failback, immediately
6536 # draining traffic. A setting of false allows existing TCP
6537 # connections to persist, even on VMs no longer in the active pool, for up
6538 # to the duration of the connection draining timeout (10 minutes).
6539 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
6540 #
6541 # The default is false.
6542 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
6543 # load balancer are dropped when all primary and all backup backend VMs are
6544 # unhealthy.If set to false, connections are distributed
6545 # among all primary VMs when all primary and all backup backend VMs are
6546 # unhealthy.
6547 # For load balancers that have configurable
6548 # failover:
6549 # [Internal passthrough
6550 # Network Load
6551 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6552 # and [external passthrough
6553 # Network Load
6554 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6555 # The default is false.
6556 &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
6557 # failover when the number of healthy primary VMs equals zero.
6558 # For all other values, the load balancer performs a failover when the
6559 # total number of healthy primary VMs is less than this ratio.
6560 # For load balancers that have configurable
6561 # failover:
6562 # [Internal TCP/UDP Load
6563 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6564 # and [external TCP/UDP Load
6565 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6566 },
6567 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
6568 # This field is used in optimistic locking. This field will be ignored when
6569 # inserting a BackendService. An up-to-date fingerprint must be provided in
6570 # order to update the BackendService, otherwise the request will
6571 # fail with error 412 conditionNotMet.
6572 #
6573 # To see the latest fingerprint, make a get() request to
6574 # retrieve a BackendService.
6575 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
6576 # Protocol Forwarding.
6577 #
6578 # The backends of this regional backend service must only specify zonal
6579 # network endpoint groups (NEGs) of type GCE_VM_IP.
6580 #
6581 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
6582 # regional backend service must set the network field. All zonal NEGs must
6583 # belong to the same network. However, individual NEGs can
6584 # belong to different subnetworks of that network.
6585 #
6586 # When haPolicy is specified, the set of attached network endpoints across
6587 # all backends comprise an High Availability domain from which one endpoint
6588 # is selected as the active endpoint (the leader) that receives all
6589 # traffic.
6590 #
6591 # haPolicy can be added only at backend service creation time. Once set up,
6592 # it cannot be deleted.
6593 #
6594 # Note that haPolicy is not for load balancing, and therefore cannot be
6595 # specified with sessionAffinity, connectionTrackingPolicy, and
6596 # failoverPolicy.
6597 #
6598 # haPolicy requires customers to be responsible for tracking backend
6599 # endpoint health and electing a leader among the healthy endpoints.
6600 # Therefore, haPolicy cannot be specified with healthChecks.
6601 #
6602 # haPolicy can only be specified for External Passthrough Network Load
6603 # Balancers and Internal Passthrough Network Load Balancers.
6604 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
6605 # achieve it.
6606 #
6607 # Supported values are:
6608 #
6609 # - DISABLED: Fast IP Move is disabled. You can only use the
6610 # haPolicy.leader API to update the leader.
6611 # - &gt;GARP_RA: Provides a method to very quickly define a new network
6612 # endpoint as the leader. This method is faster than updating the leader
6613 # using the haPolicy.leader API. Fast IP move works as follows: The VM
6614 # hosting the network endpoint that should become the new leader sends
6615 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
6616 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
6617 # temporarily associates the forwarding rule IP address with that VM, and
6618 # both new and in-flight packets are quickly delivered to that VM.
6619 #
6620 #
6621 #
6622 # Note the important properties of the Fast IP Move functionality:
6623 #
6624 # - The GARP/RA-initiated re-routing stays active for approximately 20
6625 # minutes. After triggering fast failover, you must also
6626 # appropriately set the haPolicy.leader.
6627 # - The new leader instance should continue to send GARP/RA packets
6628 # periodically every 10 seconds until at least 10 minutes after updating
6629 # the haPolicy.leader (but stop immediately if it is no longer the leader).
6630 # - After triggering a fast failover, we recommend that you wait at least
6631 # 3 seconds before sending another GARP/RA packet from a different VM
6632 # instance to avoid race conditions.
6633 # - Don&#x27;t send GARP/RA packets from different VM
6634 # instances at the same time. If multiple instances continue to send
6635 # GARP/RA packets, traffic might be routed to different destinations in an
6636 # alternating order. This condition ceases when a single instance
6637 # issues a GARP/RA packet.
6638 # - The GARP/RA request always takes priority over the leader API.
6639 # Using the haPolicy.leader API to change the leader to a different
6640 # instance will have no effect until the GARP/RA request becomes
6641 # inactive.
6642 # - The GARP/RA packets should follow the GARP/RA
6643 # Packet Specifications..
6644 # - When multiple forwarding rules refer to a regional backend service,
6645 # you need only send a GARP or RA packet for a single forwarding rule
6646 # virtual IP. The virtual IPs for all forwarding rules targeting the same
6647 # backend service will also be moved to the sender of the GARP or RA
6648 # packet.
6649 #
6650 #
6651 #
6652 # The following are the Fast IP Move limitations (that is, when fastIPMove
6653 # is not DISABLED):
6654 #
6655 # - Multiple forwarding rules cannot use the same IP address if one of
6656 # them refers to a regional backend service with fastIPMove.
6657 # - The regional backend service must set the network field, and all
6658 # NEGs must belong to that network. However, individual
6659 # NEGs can belong to different subnetworks of that network.
6660 # - The maximum number of network endpoints across all backends of a
6661 # backend service with fastIPMove is 32.
6662 # - The maximum number of backend services with fastIPMove that can have
6663 # the same network endpoint attached to one of its backends is 64.
6664 # - The maximum number of backend services with fastIPMove in a VPC in a
6665 # region is 64.
6666 # - The network endpoints that are attached to a backend of a backend
6667 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
6668 # - Traffic directed to the leader by a static route next hop will not be
6669 # redirected to a new leader by fast failover. Such traffic will only be
6670 # redirected once an haPolicy.leader update has taken effect. Only traffic
6671 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
6672 # fast failover.
6673 #
6674 #
6675 # haPolicy.fastIPMove can be set only at backend service creation time.
6676 # Once set, it cannot be updated.
6677 #
6678 # By default, fastIpMove is set to DISABLED.
6679 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
6680 # this service as the active endpoint (the leader) that receives all
6681 # traffic.
6682 #
6683 # When the leader changes, there is no connection draining to persist
6684 # existing connections on the old leader.
6685 #
6686 # You are responsible for selecting a suitable endpoint as the
6687 # leader. For example, preferring a healthy endpoint over unhealthy ones.
6688 # Note that this service does not track backend endpoint health, and
6689 # selects the configured leader unconditionally.
6690 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
6691 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
6692 # that the leader is attached to.
6693 #
6694 # The leader&#x27;s backendGroup must already be specified as a backend of
6695 # this backend service. Removing a backend that is designated as the
6696 # leader&#x27;s backendGroup is not permitted.
6697 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
6698 # designated as the leader.
6699 #
6700 # This network endpoint cannot be detached from the NEG specified in
6701 # the haPolicy.leader.backendGroup until the leader is updated with
6702 # another network endpoint, or the leader is removed from the haPolicy.
6703 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
6704 # instance must already be attached to the NEG specified in the
6705 # haPolicy.leader.backendGroup.
6706 #
6707 # The name must be 1-63 characters long, and comply with RFC1035.
6708 # Authorization requires the following IAM permission on the
6709 # specified resource instance: compute.instances.use
6710 },
6711 },
6712 },
6713 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
6714 # httpsHealthChecks (legacy) resource for health checking this backend
6715 # service. Not all backend services support legacy health checks. See
6716 # Load balancer guide. Currently, at most one health check can be
6717 # specified for each backend service. Backend services with
6718 # instance group or zonal NEG backends must have a health check unless
6719 # haPolicy is specified. Backend services with internet or serverless NEG
6720 # backends must not have a health check.
6721 #
6722 # healthChecks[] cannot be specified with haPolicy.
6723 &quot;A String&quot;,
6724 ],
6725 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
6726 # Not available for internal passthrough Network Load Balancers and external
6727 # passthrough Network Load Balancers.
6728 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
6729 # incoming requests.
6730 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
6731 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
6732 # for IAP.
6733 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
6734 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
6735 # Optional - If not provided, the name will be autogenerated by the
6736 # backend.
6737 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
6738 },
6739 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
6740 # For security reasons, this value cannot be retrieved via the API.
6741 # Instead, the SHA-256 hash of the value is returned in the
6742 # oauth2ClientSecretSha256 field.
6743 #
6744 # @InputOnly
6745 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
6746 },
6747 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
6748 # defined by the server.
6749 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
6750 # from the client to the backend for proxyless gRPC).
6751 # The possible values are:
6752 #
6753 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
6754 # backend service (Instance Group, Managed Instance Group, Network Endpoint
6755 # Group), regardless of traffic from the client to the proxy. Only IPv4
6756 # health checks are used to check the health of the backends. This is the
6757 # default setting.
6758 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
6759 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
6760 # address).
6761 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
6762 # backend service (Instance Group, Managed Instance Group, Network Endpoint
6763 # Group), regardless of traffic from the client to the proxy. Only IPv6
6764 # health checks are used to check the health of the backends.
6765 #
6766 #
6767 #
6768 # This field is applicable to either:
6769 #
6770 # - Advanced global external Application Load Balancer (load balancing
6771 # scheme EXTERNAL_MANAGED),
6772 # - Regional external Application Load
6773 # Balancer,
6774 # - Internal proxy Network Load Balancer (load balancing
6775 # scheme INTERNAL_MANAGED),
6776 # - Regional internal Application Load
6777 # Balancer (load balancing scheme INTERNAL_MANAGED),
6778 # - Traffic
6779 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
6780 # INTERNAL_SELF_MANAGED).
6781 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
6782 # for backend services.
6783 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
6784 # created for one type of load balancer cannot be used with another.
6785 # For more information, refer toChoosing
6786 # a load balancer.
6787 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
6788 # preference. When you use localityLbPolicies, you must set at least one
6789 # value for either the localityLbPolicies[].policy or the
6790 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
6791 # value set in the localityLbPolicy field.
6792 #
6793 # For an example of how to use this field, seeDefine
6794 # a list of preferred policies.
6795 #
6796 # Caution: This field and its children are intended for use in a service mesh
6797 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
6798 # that have this configuration.
6799 { # Container for either a built-in LB policy supported by gRPC or Envoy or
6800 # a custom one implemented by the end user.
6801 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
6802 # deployed with the client.
6803 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
6804 # by a locally installed custom policy implementation.
6805 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
6806 #
6807 # The value should match the name of a custom implementation registered
6808 # on the gRPC clients. It should follow protocol buffer message naming
6809 # conventions and include the full path (for example,
6810 # myorg.CustomLbPolicy). The maximum length is 256 characters.
6811 #
6812 # Do not specify the same custom policy more than once for a
6813 # backend. If you do, the configuration is rejected.
6814 #
6815 # For an example of how to use this field, seeUse
6816 # a custom policy.
6817 },
6818 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
6819 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
6820 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
6821 # about these values, see the description of localityLbPolicy.
6822 #
6823 # Do not specify the same policy more than once for a
6824 # backend. If you do, the configuration is rejected.
6825 },
6826 },
6827 ],
6828 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
6829 # possible values are:
6830 #
6831 # - ROUND_ROBIN: This is a simple policy in which each healthy
6832 # backend is selected in round robin order. This is the default.
6833 # - LEAST_REQUEST: An O(1) algorithm which
6834 # selects two random healthy hosts and picks the host which has fewer active
6835 # requests.
6836 # - RING_HASH: The ring/modulo hash load balancer implements
6837 # consistent hashing to backends. The algorithm has the property that the
6838 # addition/removal of a host from a set of N hosts only affects 1/N of the
6839 # requests.
6840 # - RANDOM: The load balancer selects a random healthy
6841 # host.
6842 # - ORIGINAL_DESTINATION: Backend host is selected
6843 # based on the client connection metadata, i.e., connections are opened to
6844 # the same address as the destination address of the incoming connection
6845 # before the connection was redirected to the load balancer.
6846 # - MAGLEV: used as a drop in replacement for the ring hash
6847 # load balancer. Maglev is not as stable as ring hash but has faster table
6848 # lookup build times and host selection times. For more information about
6849 # Maglev, see Maglev:
6850 # A Fast and Reliable Software Network Load Balancer.
6851 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
6852 # Load Balancing using weights computed from Backend reported Custom Metrics.
6853 # If set, the Backend Service responses are expected to contain non-standard
6854 # HTTP response header field Endpoint-Load-Metrics. The reported
6855 # metrics to use for computing the weights are specified via thecustomMetrics field.
6856 #
6857 # This field is applicable to either:
6858 # - A regional backend service with the service protocol set to HTTP,
6859 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6860 # INTERNAL_MANAGED.
6861 # - A global backend service with the
6862 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
6863 # EXTERNAL_MANAGED.
6864 #
6865 #
6866 # If sessionAffinity is not configured—that is, if session
6867 # affinity remains at the default value of NONE—then the
6868 # default value for localityLbPolicy
6869 # is ROUND_ROBIN. If session affinity is set to a value other
6870 # than NONE,
6871 # then the default value for localityLbPolicy isMAGLEV.
6872 #
6873 # Only ROUND_ROBIN and RING_HASH are supported
6874 # when the backend service is referenced by a URL map that is bound to
6875 # target gRPC proxy that has validateForProxyless field set to true.
6876 #
6877 # localityLbPolicy cannot be specified with haPolicy.
6878 &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
6879 # by this backend service. If logging is enabled, logs will be exported to
6880 # Stackdriver.
6881 # backend service.
6882 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
6883 # traffic served by this backend service. The default value is false.
6884 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
6885 { # Determines which HTTP headers will be logged to Stackdriver.
6886 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6887 },
6888 ],
6889 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
6890 { # Determines which HTTP headers will be logged to Stackdriver.
6891 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6892 },
6893 ],
6894 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
6895 # This field can only be specified if logging is enabled for this backend
6896 # service. Configures whether all, none or a subset of optional fields
6897 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
6898 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
6899 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
6900 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
6901 # of optional fields you want to include in the logs. For example:
6902 # serverInstance, serverGkeDetails.cluster,
6903 # serverGkeDetails.pod.podNamespace
6904 &quot;A String&quot;,
6905 ],
6906 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
6907 # service. Configures whether all, none or a subset of optional fields
6908 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
6909 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
6910 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
6911 # service. The value of the field must be in [0, 1]. This configures the
6912 # sampling rate of requests to the load balancer where 1.0 means all logged
6913 # requests are reported and 0.0 means no logged requests are reported. The
6914 # default value is 1.0.
6915 },
6916 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
6917 # service. Duration is computed from the beginning of the stream until the
6918 # response has been completely processed, including all retries. A stream
6919 # that does not complete in this duration is closed.
6920 #
6921 # If not specified, there will be no timeout limit, i.e. the maximum
6922 # duration is infinite.
6923 #
6924 # This value can be overridden in the PathMatcher configuration of the
6925 # UrlMap that references this backend service.
6926 #
6927 # This field is only allowed when the loadBalancingScheme of
6928 # the backend service is INTERNAL_SELF_MANAGED.
6929 # as a count of seconds and fractions of seconds at nanosecond
6930 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6931 # or &quot;month&quot;. Range is approximately 10,000 years.
6932 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6933 # Durations less than one second are represented with a 0
6934 # `seconds` field and a positive `nanos` field. Must be from 0
6935 # to 999,999,999 inclusive.
6936 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6937 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6938 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6939 },
6940 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
6941 # controller and read by the backend RCTH
6942 &quot;a_key&quot;: &quot;A String&quot;,
6943 },
6944 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6945 # The name must be 1-63 characters long, and comply withRFC1035.
6946 # Specifically, the name must be 1-63 characters long and match the regular
6947 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6948 # character must be a lowercase letter, and all following characters must
6949 # be a dash, lowercase letter, or digit, except the last character, which
6950 # cannot be a dash.
6951 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
6952 #
6953 # This field must be set for Internal Passthrough Network Load Balancers when
6954 # the haPolicy is enabled, and for External Passthrough Network Load
6955 # Balancers when the haPolicy fastIpMove is enabled.
6956 #
6957 # 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.
6958 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
6959 # Load Balancers.
6960 #
6961 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
6962 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
6963 # endpoints in the local zone.
6964 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
6965 # possible values are:
6966 #
6967 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
6968 # is disabled. The load balancer distributes new connections to all
6969 # healthy backend endpoints across all zones.
6970 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
6971 # enabled. The load balancer distributes new connections to all healthy
6972 # backend endpoints in the local zone only. If there are no healthy
6973 # backend endpoints in the local zone, the load balancer distributes
6974 # new connections to all backend endpoints in the local zone.
6975 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
6976 # enabled. The load balancer distributes new connections to all healthy
6977 # backend endpoints in the local zone only. If there aren&#x27;t enough
6978 # healthy backend endpoints in the local zone, the load balancer
6979 # distributes new connections to all healthy backend endpoints across all
6980 # zones.
6981 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
6982 # of healthy backend endpoints in a zone to the count of backend
6983 # endpoints in that same zone is equal to or above this threshold, the
6984 # load balancer distributes new connections to all healthy endpoints in
6985 # the local zone only. When the ratio of the count of healthy backend
6986 # endpoints in a zone to the count of backend endpoints in that same
6987 # zone is below this threshold, the load balancer distributes all new
6988 # connections to all healthy endpoints across all zones.
6989 },
6990 },
6991 &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.
6992 # the backend service.
6993 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
6994 # service.
6995 },
6996 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
6997 # load balancing pool of each individual proxy instance that processes the
6998 # traffic for the given backend service. If not set, this feature is
6999 # considered disabled.
7000 #
7001 # Results of the outlier detection algorithm (ejection of endpoints from the
7002 # load balancing pool and returning them back to the pool) are executed
7003 # independently by each proxy instance of the load balancer. In most cases,
7004 # more than one proxy instance handles the traffic received by a backend
7005 # service. Thus, it is possible that an unhealthy endpoint is detected and
7006 # ejected by only some of the proxies, and while this happens, other proxies
7007 # may continue to send requests to the same unhealthy endpoint until they
7008 # detect and eject the unhealthy endpoint.
7009 #
7010 # Applicable backend endpoints can be:
7011 #
7012 # - VM instances in an Instance Group
7013 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
7014 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
7015 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
7016 # Functions Services
7017 # - Private Service Connect NEGs, that resolve to
7018 # Google-managed regional API endpoints or managed services published using
7019 # Private Service Connect
7020 #
7021 #
7022 #
7023 # Applicable backend service types can be:
7024 #
7025 # - A global backend service with the loadBalancingScheme set to
7026 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
7027 # - A regional backend
7028 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
7029 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
7030 # supported for Serverless NEGs.
7031 #
7032 #
7033 #
7034 # Not supported when the backend service is referenced by a URL map that is
7035 # bound to target gRPC proxy that has validateForProxyless field set to true.
7036 # pool for the backend service.
7037 &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
7038 # or 30s.
7039 #
7040 # After a backend endpoint is returned back to the load balancing pool, it
7041 # can be ejected again in another ejection analysis. Thus, the total ejection
7042 # time is equal to the base ejection time multiplied by the number of times
7043 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
7044 # as a count of seconds and fractions of seconds at nanosecond
7045 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7046 # or &quot;month&quot;. Range is approximately 10,000 years.
7047 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7048 # Durations less than one second are represented with a 0
7049 # `seconds` field and a positive `nanos` field. Must be from 0
7050 # to 999,999,999 inclusive.
7051 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7052 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7053 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7054 },
7055 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
7056 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
7057 # return code qualifies as an error. Defaults to 5.
7058 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
7059 # connection errors that are mapped to one of those status codes) before a
7060 # consecutive gateway failure ejection occurs. Defaults to 3.
7061 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7062 # outlier status is detected through consecutive 5xx. This setting can be
7063 # used to disable ejection or to ramp it up slowly. Defaults to 0.
7064 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7065 # outlier status is detected through consecutive gateway failures. This
7066 # setting can be used to disable ejection or to ramp it up slowly. Defaults
7067 # to 100.
7068 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7069 # outlier status is detected through success rate statistics. This setting
7070 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
7071 #
7072 # Not supported when the backend service uses Serverless NEG.
7073 &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
7074 # ejections and backend endpoints being returned to service. The interval is
7075 # equal to the number of seconds as defined in
7076 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
7077 # in outlierDetection.interval.nanos. Defaults to 1 second.
7078 # as a count of seconds and fractions of seconds at nanosecond
7079 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7080 # or &quot;month&quot;. Range is approximately 10,000 years.
7081 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7082 # Durations less than one second are represented with a 0
7083 # `seconds` field and a positive `nanos` field. Must be from 0
7084 # to 999,999,999 inclusive.
7085 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7086 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7087 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7088 },
7089 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
7090 # backend service that can be ejected if the ejection conditions are met.
7091 # Defaults to 50%.
7092 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
7093 # enough request volume to detect success rate outliers. If the number of
7094 # backend endpoints is fewer than this setting, outlier detection via success
7095 # rate statistics is not performed for any backend endpoint in the load
7096 # balancing pool. Defaults to 5.
7097 #
7098 # Not supported when the backend service uses Serverless NEG.
7099 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
7100 # (as defined by the interval duration above) to include this backend
7101 # endpoint in success rate based outlier detection. If the volume is lower
7102 # than this setting, outlier detection via success rate statistics is not
7103 # performed for that backend endpoint. Defaults to 100.
7104 #
7105 # Not supported when the backend service uses Serverless NEG.
7106 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
7107 # outlier ejection. The ejection threshold is the difference between the mean
7108 # success rate, and the product of this factor and the standard deviation of
7109 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
7110 # is divided by a thousand to get a double. That is, if the desired factor
7111 # is 1.9, the runtime value should be 1900. Defaults to 1900.
7112 #
7113 # Not supported when the backend service uses Serverless NEG.
7114 },
7115 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7116 # as part of resource payload.
7117 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7118 # Tag keys and values have the same definition as resource
7119 # manager tags. The field is allowed for INSERT
7120 # only. The keys/values to set on the resource should be specified in
7121 # either ID { : } or Namespaced format
7122 # { : }.
7123 # For example the following are valid inputs:
7124 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7125 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7126 # Note:
7127 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7128 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7129 &quot;a_key&quot;: &quot;A String&quot;,
7130 },
7131 },
7132 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
7133 # the backend. The default value is 80.
7134 # For internal passthrough Network Load Balancers and external passthrough
7135 # Network Load Balancers, omit port.
7136 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
7137 # communication to the backend VMs in that group. The
7138 # named port must be [defined on each backend instance
7139 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
7140 # This parameter has no meaning if the backends are NEGs. For internal
7141 # passthrough Network Load Balancers and external passthrough Network Load
7142 # Balancers, omit port_name.
7143 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
7144 # with backends.
7145 #
7146 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
7147 # depending on the chosen load balancer or Traffic Director configuration.
7148 # Refer to the documentation for the load balancers or for Traffic Director
7149 # for more information.
7150 #
7151 # Must be set to GRPC when the backend service is referenced by a URL map
7152 # that is bound to target gRPC proxy.
7153 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
7154 # resides. This field is not applicable to global backend services.
7155 # You must specify this field as part of the HTTP request URL. It is
7156 # not settable as a field in the request body.
7157 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
7158 # backend service.
7159 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
7160 # service. This field is applicable to a global backend service with the
7161 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7162 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
7163 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
7164 # be accepted on backends, and if authenticated, which method/certificate
7165 # will set the request principal.
7166 # request principal.
7167 # The authentication settings for the backend service.
7168 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
7169 # Similar to peers, these will be evaluated in order the first valid one
7170 # will be used to set origin identity. If none of these methods pass, the
7171 # request will be rejected with authentication failed error (401). Leave the
7172 # list empty if origin authentication is not required.
7173 { # [Deprecated] Configuration for the origin authentication method.
7174 # Configuration for the origin authentication method.
7175 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
7176 # JWT configuration for origin authentication.
7177 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
7178 # will be accepted if audiences is empty.
7179 # Examples: bookstore_android.apps.googleusercontent.com,
7180 # bookstore_web.apps.googleusercontent.com
7181 &quot;A String&quot;,
7182 ],
7183 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
7184 # email address.
7185 # Examples: https://securetoken.google.com,
7186 # [email protected]
7187 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
7188 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
7189 # request. If no explicit location is specified, the following default
7190 # locations are tried in order:
7191 #
7192 # 1. The Authorization header using the Bearer schema. See `here
7193 # `_. Example:
7194 #
7195 # Authorization: Bearer .
7196 #
7197 # 2. `access_token` query parameter. See `this
7198 # `_
7199 #
7200 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
7201 # from the locations its issuer specified or from the default locations.
7202 #
7203 # This field is set if JWT is sent in a request header. This field specifies
7204 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
7205 # header format will be x-goog-iap-jwt-assertion: .
7206 { # [Deprecated] This message specifies a header location to extract JWT token.
7207 # This message specifies a header location to extract JWT token.
7208 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
7209 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
7210 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
7211 # with a space at the end.
7212 },
7213 ],
7214 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
7215 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
7216 # JWT format in the query parameter is /path?jwt_token=.
7217 &quot;A String&quot;,
7218 ],
7219 },
7220 },
7221 ],
7222 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
7223 # They will be evaluated in order the first valid one will be used to set
7224 # peer identity. If none of these methods pass, the request will be rejected
7225 # with authentication failed error (401). Leave the list empty if peer
7226 # authentication is not required.
7227 { # [Deprecated] Configuration for the peer authentication method.
7228 # Configuration for the peer authentication method.
7229 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
7230 # Configuration for the mutual Tls mode for peer authentication.
7231 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
7232 # field can be set to one of the following:
7233 # STRICT: Client certificate must be presented, connection is in TLS.
7234 # PERMISSIVE: Client certificate can be omitted, connection can be either
7235 # plaintext or TLS.
7236 },
7237 },
7238 ],
7239 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
7240 # Default value is USE_PEER. If peer (or origin) identity is not available,
7241 # either because peer/origin authentication is not defined, or failed,
7242 # principal will be left unset. In other words, binding rule does not affect
7243 # the decision to accept or reject request. This field can be set to one of
7244 # the following:
7245 # USE_PEER: Principal will be set to the identity from peer authentication.
7246 # USE_ORIGIN: Principal will be set to the identity from origin
7247 # authentication.
7248 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
7249 # identity information.
7250 # The TLS settings for the client or server.
7251 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
7252 # certificate.
7253 # Defines the mechanism to obtain the client or server certificate.
7254 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
7255 # applicable only if tlsCertificateSource is set to USE_PATH.
7256 # The paths to the mounted TLS Certificates and private key.
7257 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7258 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7259 },
7260 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
7261 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
7262 # is applicable only if tlsCertificateSource is set to USE_SDS.
7263 # The configuration to access the SDS server.
7264 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
7265 # gRPC config to access the SDS server.
7266 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
7267 # gRPC call credentials to access the SDS server.
7268 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
7269 # This field can be set to one of the following:
7270 #
7271 # - GCE_VM: The local GCE VM service account credentials are used to access
7272 # the SDS server.
7273 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
7274 # SDS server.
7275 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
7276 # FROM_PLUGIN.
7277 # Custom authenticator credentials.
7278 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
7279 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
7280 # plugin.
7281 },
7282 },
7283 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
7284 # gRPC channel credentials to access the SDS server.
7285 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
7286 # The paths to the mounted TLS Certificates and private key.
7287 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7288 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7289 },
7290 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
7291 # to one of the following:
7292 # CERTIFICATES: Use TLS certificates to access the SDS server.
7293 # GCE_VM: Use local GCE VM credentials to access the SDS server.
7294 },
7295 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
7296 },
7297 },
7298 },
7299 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
7300 # validate the client/server certificate. If omitted, the proxy will not
7301 # validate the server or client certificate.
7302 # certificate to validate the client/server certificate.
7303 # validate the client/server certificate.
7304 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
7305 # client or server certificate.
7306 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
7307 # is applicable only if tlsCertificateSource is set to USE_SDS.
7308 # The configuration to access the SDS server.
7309 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
7310 # gRPC config to access the SDS server.
7311 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
7312 # gRPC call credentials to access the SDS server.
7313 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
7314 # This field can be set to one of the following:
7315 #
7316 # - GCE_VM: The local GCE VM service account credentials are used to access
7317 # the SDS server.
7318 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
7319 # SDS server.
7320 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
7321 # FROM_PLUGIN.
7322 # Custom authenticator credentials.
7323 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
7324 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
7325 # plugin.
7326 },
7327 },
7328 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
7329 # gRPC channel credentials to access the SDS server.
7330 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
7331 # The paths to the mounted TLS Certificates and private key.
7332 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7333 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7334 },
7335 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
7336 # to one of the following:
7337 # CERTIFICATES: Use TLS certificates to access the SDS server.
7338 # GCE_VM: Use local GCE VM credentials to access the SDS server.
7339 },
7340 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
7341 },
7342 },
7343 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
7344 },
7345 },
7346 },
7347 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
7348 # (RBAC) config.
7349 # Authorization config defines the Role Based Access Control (RBAC) config.
7350 # method-level access control for a service.
7351 # control for a service.
7352 &quot;policies&quot;: [ # List of RbacPolicies.
7353 {
7354 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
7355 &quot;permissions&quot;: [ # The list of permissions.
7356 { # [Deprecated] All fields defined in a permission are ANDed.
7357 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
7358 { # Custom constraint that specifies a key and a list of allowed values for
7359 # Istio attributes.
7360 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
7361 &quot;values&quot;: [ # A list of allowed values.
7362 &quot;A String&quot;,
7363 ],
7364 },
7365 ],
7366 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
7367 # applies to. Exact match, prefix match, and suffix match are supported.
7368 &quot;A String&quot;,
7369 ],
7370 &quot;methods&quot;: [ # HTTP method.
7371 &quot;A String&quot;,
7372 ],
7373 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
7374 &quot;A String&quot;,
7375 ],
7376 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
7377 &quot;A String&quot;,
7378 ],
7379 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
7380 &quot;A String&quot;,
7381 ],
7382 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
7383 &quot;A String&quot;,
7384 ],
7385 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
7386 # Exact match, prefix match, and suffix match are supported.
7387 &quot;A String&quot;,
7388 ],
7389 &quot;ports&quot;: [ # Port names or numbers.
7390 &quot;A String&quot;,
7391 ],
7392 },
7393 ],
7394 &quot;principals&quot;: [ # The list of principals.
7395 { # [Deprecated] All fields defined in a principal are ANDed.
7396 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
7397 &quot;groups&quot;: [ # The groups the principal belongs to.
7398 # Exact match, prefix match, and suffix match are supported.
7399 &quot;A String&quot;,
7400 ],
7401 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
7402 &quot;A String&quot;,
7403 ],
7404 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
7405 &quot;A String&quot;,
7406 ],
7407 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
7408 &quot;A String&quot;,
7409 ],
7410 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
7411 &quot;A String&quot;,
7412 ],
7413 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
7414 &quot;A String&quot;,
7415 ],
7416 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
7417 &quot;A String&quot;,
7418 ],
7419 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
7420 # suffix match are supported for values. For example,
7421 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
7422 &quot;a_key&quot;: &quot;A String&quot;,
7423 },
7424 &quot;users&quot;: [ # The user names/IDs or service accounts.
7425 # Exact match, prefix match, and suffix match are supported.
7426 &quot;A String&quot;,
7427 ],
7428 },
7429 ],
7430 },
7431 ],
7432 },
7433 &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
7434 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
7435 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
7436 # private storage buckets that support Signature Version 4 for authentication.
7437 # The service name for generating the authentication header will always default
7438 # to &#x27;s3&#x27;.
7439 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
7440 # creating a backend that uses AWS v4 signature authentication, but will not
7441 # be returned as part of the configuration when queried with a REST API GET
7442 # request.
7443 #
7444 # @InputOnly
7445 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
7446 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
7447 # keep track of different iterations of your access key.
7448 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
7449 # the name of the region your cloud uses to host your origin. For example,
7450 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
7451 },
7452 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
7453 # that describes how clients should authenticate with this service&#x27;s
7454 # backends.
7455 #
7456 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
7457 # to INTERNAL_SELF_MANAGED.
7458 #
7459 # If left blank, communications are not encrypted.
7460 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
7461 # originating from the backend service.
7462 # the backend service.
7463 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
7464 # identity information. This field is only applicable when mode is set to
7465 # MUTUAL.
7466 # The TLS settings for the client or server.
7467 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
7468 # certificate.
7469 # Defines the mechanism to obtain the client or server certificate.
7470 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
7471 # applicable only if tlsCertificateSource is set to USE_PATH.
7472 # The paths to the mounted TLS Certificates and private key.
7473 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7474 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7475 },
7476 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
7477 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
7478 # is applicable only if tlsCertificateSource is set to USE_SDS.
7479 # The configuration to access the SDS server.
7480 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
7481 # gRPC config to access the SDS server.
7482 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
7483 # gRPC call credentials to access the SDS server.
7484 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
7485 # This field can be set to one of the following:
7486 #
7487 # - GCE_VM: The local GCE VM service account credentials are used to access
7488 # the SDS server.
7489 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
7490 # SDS server.
7491 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
7492 # FROM_PLUGIN.
7493 # Custom authenticator credentials.
7494 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
7495 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
7496 # plugin.
7497 },
7498 },
7499 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
7500 # gRPC channel credentials to access the SDS server.
7501 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
7502 # The paths to the mounted TLS Certificates and private key.
7503 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7504 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7505 },
7506 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
7507 # to one of the following:
7508 # CERTIFICATES: Use TLS certificates to access the SDS server.
7509 # GCE_VM: Use local GCE VM credentials to access the SDS server.
7510 },
7511 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
7512 },
7513 },
7514 },
7515 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
7516 # validate the client/server certificate. If omitted, the proxy will not
7517 # validate the server or client certificate.
7518 # certificate to validate the client/server certificate.
7519 # validate the client/server certificate.
7520 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
7521 # client or server certificate.
7522 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
7523 # is applicable only if tlsCertificateSource is set to USE_SDS.
7524 # The configuration to access the SDS server.
7525 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
7526 # gRPC config to access the SDS server.
7527 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
7528 # gRPC call credentials to access the SDS server.
7529 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
7530 # This field can be set to one of the following:
7531 #
7532 # - GCE_VM: The local GCE VM service account credentials are used to access
7533 # the SDS server.
7534 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
7535 # SDS server.
7536 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
7537 # FROM_PLUGIN.
7538 # Custom authenticator credentials.
7539 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
7540 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
7541 # plugin.
7542 },
7543 },
7544 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
7545 # gRPC channel credentials to access the SDS server.
7546 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
7547 # The paths to the mounted TLS Certificates and private key.
7548 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
7549 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
7550 },
7551 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
7552 # to one of the following:
7553 # CERTIFICATES: Use TLS certificates to access the SDS server.
7554 # GCE_VM: Use local GCE VM credentials to access the SDS server.
7555 },
7556 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
7557 },
7558 },
7559 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
7560 },
7561 },
7562 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
7563 # The value of this field determines how TLS is enforced. This can be set
7564 # to one of the following values: DISABLE: Do not setup a TLS connection to
7565 # the backends.
7566 # SIMPLE: Originate a TLS connection to the backends.
7567 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
7568 # client certificates for authentication.
7569 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
7570 # applicable only when mode is SIMPLE or MUTUAL.
7571 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
7572 # certificate.If specified,
7573 # the proxy will verify that the server certificate&#x27;s subject alt name
7574 # matches one of the specified values. This field is applicable only when
7575 # mode is SIMPLE or MUTUAL.
7576 &quot;A String&quot;,
7577 ],
7578 },
7579 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
7580 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
7581 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
7582 # specified values, the communication continues. Otherwise, it fails. This
7583 # additional check enables the client to verify that the server is authorized
7584 # to run the requested service.
7585 #
7586 # Note that the contents of the server
7587 # certificate&#x27;s subjectAltName field are configured by the
7588 # Public Key Infrastructure which provisions server identities.
7589 #
7590 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
7591 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
7592 # mode).
7593 &quot;A String&quot;,
7594 ],
7595 },
7596 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7597 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7598 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
7599 #
7600 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
7601 # If set, lists of backends and health checks must be both empty.
7602 &quot;A String&quot;,
7603 ],
7604 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
7605 #
7606 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
7607 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
7608 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
7609 #
7610 # Only NONE and HEADER_FIELD are supported
7611 # when the backend service is referenced by a URL map that is bound to
7612 # target gRPC proxy that has validateForProxyless field set to true.
7613 #
7614 # For more details, see:
7615 # [Session
7616 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
7617 #
7618 # sessionAffinity cannot be specified with haPolicy.
7619 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
7620 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
7621 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7622 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7623 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7624 # as a count of seconds and fractions of seconds at nanosecond
7625 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7626 # or &quot;month&quot;. Range is approximately 10,000 years.
7627 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7628 # Durations less than one second are represented with a 0
7629 # `seconds` field and a positive `nanos` field. Must be from 0
7630 # to 999,999,999 inclusive.
7631 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7632 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7633 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7634 },
7635 },
7636 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
7637 # Currently this is applicable only for Internal TCP/UDP load balancing,
7638 # Internal HTTP(S) load balancing and Traffic Director.
7639 &quot;policy&quot;: &quot;A String&quot;,
7640 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
7641 # each service mesh client.
7642 #
7643 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
7644 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
7645 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
7646 # `INTERNAL_SELF_MANAGED`.
7647 #
7648 # `subset_size` is optional for Internal HTTP(S) load balancing
7649 # and required for Traffic Director.
7650 #
7651 # If you do not provide this value, Cloud Load Balancing will calculate it
7652 # dynamically to optimize the number of proxies/clients visible to each
7653 # backend and vice versa.
7654 #
7655 # Must be greater than 0. If `subset_size` is larger than the number of
7656 # backends/endpoints, then subsetting is disabled.
7657 },
7658 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
7659 # type of load balancer. For more information see,
7660 # Backend service settings.
7661 # The default is 30 seconds.
7662 # The full range of timeout values allowed goes from 1
7663 # through 2,147,483,647 seconds.
7664 #
7665 # This value can be overridden in the PathMatcher configuration of the
7666 # UrlMap that references this backend service.
7667 #
7668 # Not supported when the backend service is referenced by a URL map that is
7669 # bound to target gRPC proxy that has validateForProxyless field set to true.
7670 # Instead, use maxStreamDuration.
7671 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
7672 # when the backend protocol is SSL, HTTPS or HTTP2.
7673 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
7674 # networksecurity.googleapis.com namespace. Can be used in authenticating
7675 # TLS connections to the backend, as specified by the authenticationMode
7676 # field. Can only be specified if authenticationMode is not NONE.
7677 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
7678 #
7679 #
7680 # Use this property to configure the load balancer back-end to use
7681 # certificates and roots of trust provisioned by the Managed Workload
7682 # Identity system.
7683 #
7684 # The `identity` property is the
7685 # fully-specified SPIFFE ID to use in the SVID presented by the Load
7686 # Balancer Workload.
7687 #
7688 # The SPIFFE ID must be a resource starting with the
7689 # `trustDomain` property value, followed by the path to the Managed
7690 # Workload Identity.
7691 #
7692 # Supported SPIFFE ID format:
7693 #
7694 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
7695 #
7696 #
7697 # The Trust Domain within the Managed Identity must refer to a valid
7698 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
7699 # will be inherited from the Workload Identity Pool.
7700 #
7701 # Restrictions:
7702 #
7703 # - If you set the `identity` property, you cannot manually set
7704 # the following fields:
7705 # - tlsSettings.sni
7706 # - tlsSettings.subjectAltNames
7707 # - tlsSettings.authenticationConfig
7708 #
7709 #
7710 # When defining a `identity` for a RegionBackendServices, the
7711 # corresponding Workload Identity Pool must have a ca_pool
7712 # configured in the same region.
7713 #
7714 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
7715 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
7716 # balancer sends this string as the SNI hostname in the TLS connection to
7717 # the backend, and requires that this string match a Subject Alternative
7718 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
7719 # NEG backend, if the SNI is specified here, the load balancer uses it
7720 # regardless of whether the Regional Internet NEG is specified with FQDN or
7721 # IP address and port. When both sni and subjectAltNames[] are specified,
7722 # the load balancer matches the backend certificate&#x27;s SAN only to
7723 # subjectAltNames[].
7724 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
7725 # verifies during a TLS handshake with the backend. When the server
7726 # presents its X.509 certificate to the Load Balancer, the Load Balancer
7727 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
7728 # match one of the subjectAltNames in the list. This field is limited to 5
7729 # entries. When both sni and subjectAltNames[] are specified, the load
7730 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
7731 { # A Subject Alternative Name that the load balancer matches against the SAN
7732 # field in the TLS certificate provided by the backend, specified as either
7733 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
7734 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
7735 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
7736 },
7737 ],
7738 },
7739 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
7740 {
7741 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
7742 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
7743 # and ForwardingRule.
7744 },
7745 ],
7746 }
7747
7748 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7749 that if you must retry your request, the server will know to ignore the
7750 request if it has already been completed.
7751
7752 For example, consider a situation where you make an initial request and
7753 the request times out. If you make the request again with the same
7754 request ID, the server can check if original operation with the same
7755 request ID was received, and if so, will ignore the second request. This
7756 prevents clients from accidentally creating duplicate commitments.
7757
7758 The request ID must be
7759 a valid UUID with the exception that zero UUID is not supported
7760 (00000000-0000-0000-0000-000000000000).
7761 x__xgafv: string, V1 error format.
7762 Allowed values
7763 1 - v1 error format
7764 2 - v2 error format
7765
7766 Returns:
7767 An object of the form:
7768
7769 { # Represents an Operation resource.
7770 #
7771 # Google Compute Engine has three Operation resources:
7772 #
7773 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
7774 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
7775 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
7776 #
7777 # You can use an operation resource to manage asynchronous API requests.
7778 # For more information, readHandling
7779 # API responses.
7780 #
7781 # Operations can be global, regional or zonal.
7782 #
7783 # - For global operations, use the `globalOperations`
7784 # resource.
7785 # - For regional operations, use the
7786 # `regionOperations` resource.
7787 # - For zonal operations, use
7788 # the `zoneOperations` resource.
7789 #
7790 #
7791 #
7792 # For more information, read
7793 # Global, Regional, and Zonal Resources.
7794 #
7795 # Note that completed Operation resources have a limited
7796 # retention period.
7797 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7798 # Not present otherwise.
7799 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7800 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7801 # set when the operation is created.
7802 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7803 # text format.
7804 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7805 # this field will be populated.
7806 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7807 # operation.
7808 {
7809 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7810 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7811 # details. There is a set of defined message types to use for providing
7812 # details.The syntax depends on the error code. For example,
7813 # QuotaExceededInfo will have details when the error code is
7814 # QUOTA_EXCEEDED.
7815 {
7816 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7817 #
7818 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7819 # is not enabled:
7820 #
7821 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7822 # &quot;domain&quot;: &quot;googleapis.com&quot;
7823 # &quot;metadata&quot;: {
7824 # &quot;resource&quot;: &quot;projects/123&quot;,
7825 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7826 # }
7827 # }
7828 #
7829 # This response indicates that the pubsub.googleapis.com API is not enabled.
7830 #
7831 # Example of an error that is returned when attempting to create a Spanner
7832 # instance in a region that is out of stock:
7833 #
7834 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7835 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7836 # &quot;metadata&quot;: {
7837 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7838 # }
7839 # }
7840 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7841 # is typically the registered service name of the tool or product that
7842 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7843 # generated by some common infrastructure, the error domain must be a
7844 # globally unique value that identifies the infrastructure. For Google API
7845 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7846 &quot;metadatas&quot;: { # Additional structured details about this error.
7847 #
7848 # Keys must match a regular expression of `a-z+` but should
7849 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7850 # length. When identifying the current value of an exceeded limit, the units
7851 # should be contained in the key, not the value. For example, rather than
7852 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7853 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7854 # instances that can be created in a single (batch) request.
7855 &quot;a_key&quot;: &quot;A String&quot;,
7856 },
7857 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7858 # proximate cause of the error. Error reasons are unique within a particular
7859 # domain of errors. This should be at most 63 characters and match a
7860 # regular expression of `A-Z+[A-Z0-9]`, which represents
7861 # UPPER_SNAKE_CASE.
7862 },
7863 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7864 #
7865 # For example, if a quota check failed with an error indicating the calling
7866 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7867 # directly to the right place in the developer console to flip the bit.
7868 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7869 { # Describes a URL link.
7870 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7871 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7872 },
7873 ],
7874 },
7875 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7876 # which can be attached to an RPC error.
7877 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7878 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7879 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7880 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7881 },
7882 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7883 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7884 &quot;a_key&quot;: &quot;A String&quot;,
7885 },
7886 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7887 # type or metric.
7888 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7889 # or metric.
7890 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7891 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7892 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7893 },
7894 },
7895 ],
7896 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7897 # This property is optional.
7898 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7899 },
7900 ],
7901 },
7902 &quot;getVersionOperationMetadata&quot;: {
7903 &quot;inlineSbomInfo&quot;: {
7904 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7905 # appropriate identifiers.
7906 &quot;a_key&quot;: &quot;A String&quot;,
7907 },
7908 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7909 # identifiers.
7910 &quot;a_key&quot;: &quot;A String&quot;,
7911 },
7912 },
7913 },
7914 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7915 # message that was returned, such as `NOT FOUND`.
7916 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7917 # status code that was returned. For example, a `404` means the
7918 # resource was not found.
7919 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7920 # defined by the server.
7921 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7922 # This value is inRFC3339
7923 # text format.
7924 &quot;instancesBulkInsertOperationMetadata&quot;: {
7925 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7926 # Example key: zones/us-central1-a
7927 &quot;a_key&quot;: {
7928 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7929 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7930 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7931 # error.
7932 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7933 # if the flow is rolling forward or rolling back.
7934 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7935 },
7936 },
7937 },
7938 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7939 # Operation resources.
7940 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7941 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7942 # group of operations results from a `bulkInsert` API request.
7943 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7944 # `update`, or `delete`, and so on.
7945 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7946 # There is no requirement that this be linear or support any granularity of
7947 # operations. This should not be used to guess when the operation will be
7948 # complete. This number should monotonically increase as the operation
7949 # progresses.
7950 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7951 # applicable when performing regional operations.
7952 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7953 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
7954 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7955 # this field will contain information on all underlying zonal actions and
7956 # their state.
7957 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7958 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7959 # Example key: zones/us-central1-a
7960 &quot;a_key&quot;: {
7961 &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
7962 # populated.
7963 # different programming environments, including REST APIs and RPC APIs. It is
7964 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7965 # three pieces of data: error code, error message, and error details.
7966 #
7967 # You can find out more about this error model and how to work with it in the
7968 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7969 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7970 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7971 # message types for APIs to use.
7972 {
7973 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7974 },
7975 ],
7976 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7977 # user-facing error message should be localized and sent in the
7978 # google.rpc.Status.details field, or localized by the client.
7979 },
7980 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7981 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7982 },
7983 },
7984 },
7985 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7986 # This value is inRFC3339
7987 # text format.
7988 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7989 # following:
7990 # `PENDING`, `RUNNING`, or `DONE`.
7991 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7992 # operation.
7993 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7994 # of the target resource.
7995 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7996 # operations related to creating a snapshot, this points to the disk
7997 # that the snapshot was created from.
7998 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7999 # `[email protected]` or
8000 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8001 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8002 # operation, this field will be populated.
8003 {
8004 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8005 # Engine returns NO_RESULTS_ON_PAGE if there
8006 # are no results in the response.
8007 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8008 # value format. For example:
8009 #
8010 # &quot;data&quot;: [
8011 # {
8012 # &quot;key&quot;: &quot;scope&quot;,
8013 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8014 # }
8015 {
8016 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8017 # returned. For example, for warnings where there are no results in a list
8018 # request for a particular zone, this key might be scope and
8019 # the key value might be the zone name. Other examples might be a key
8020 # indicating a deprecated resource and a suggested replacement, or a
8021 # warning about invalid network settings (for example, if an instance
8022 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8023 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8024 },
8025 ],
8026 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8027 },
8028 ],
8029 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8030 # applicable when performing per-zone operations.
8031 }</pre>
8032 </div>
8033
8034 <div class="method">
8035 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
8036 <pre>Retrieves the list of BackendService resources available to the specified
8037 project.
8038
8039 Args:
8040 project: string, Project ID for this request. (required)
8041 filter: string, A filter expression that filters resources listed in the response. Most
8042 Compute resources support two types of filter expressions:
8043 expressions that support regular expressions and expressions that follow
8044 API improvement proposal AIP-160.
8045 These two types of filter expressions cannot be mixed in one request.
8046
8047 If you want to use AIP-160, your expression must specify the field name, an
8048 operator, and the value that you want to use for filtering. The value
8049 must be a string, a number, or a boolean. The operator
8050 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
8051
8052 For example, if you are filtering Compute Engine instances, you can
8053 exclude instances named `example-instance` by specifying
8054 `name != example-instance`.
8055
8056 The `:*` comparison can be used to test whether a key has been defined.
8057 For example, to find all objects with `owner` label use:
8058 ```
8059 labels.owner:*
8060 ```
8061
8062 You can also filter nested fields. For example, you could specify
8063 `scheduling.automaticRestart = false` to include instances only
8064 if they are not scheduled for automatic restarts. You can use filtering
8065 on nested fields to filter based onresource labels.
8066
8067 To filter on multiple expressions, provide each separate expression within
8068 parentheses. For example:
8069 ```
8070 (scheduling.automaticRestart = true)
8071 (cpuPlatform = &quot;Intel Skylake&quot;)
8072 ```
8073 By default, each expression is an `AND` expression. However, you
8074 can include `AND` and `OR` expressions explicitly.
8075 For example:
8076 ```
8077 (cpuPlatform = &quot;Intel Skylake&quot;) OR
8078 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
8079 (scheduling.automaticRestart = true)
8080 ```
8081
8082 If you want to use a regular expression, use the `eq` (equal) or `ne`
8083 (not equal) operator against a single un-parenthesized expression with or
8084 without quotes or against multiple parenthesized expressions. Examples:
8085
8086 `fieldname eq unquoted literal`
8087 `fieldname eq &#x27;single quoted literal&#x27;`
8088 `fieldname eq &quot;double quoted literal&quot;`
8089 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
8090
8091 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
8092 The literal value must match the entire field.
8093
8094 For example, to filter for instances that do not end with name &quot;instance&quot;,
8095 you would use `name ne .*instance`.
8096
8097 You cannot combine constraints on multiple fields using regular
8098 expressions.
8099 maxResults: integer, The maximum number of results per page that should be returned.
8100 If the number of available results is larger than `maxResults`,
8101 Compute Engine returns a `nextPageToken` that can be used to get
8102 the next page of results in subsequent list requests. Acceptable values are
8103 `0` to `500`, inclusive. (Default: `500`)
8104 orderBy: string, Sorts list results by a certain order. By default, results
8105 are returned in alphanumerical order based on the resource name.
8106
8107 You can also sort results in descending order based on the creation
8108 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
8109 results based on the `creationTimestamp` field in
8110 reverse chronological order (newest result first). Use this to sort
8111 resources like operations so that the newest operation is returned first.
8112
8113 Currently, only sorting by `name` or
8114 `creationTimestamp desc` is supported.
8115 pageToken: string, Specifies a page token to use. Set `pageToken` to the
8116 `nextPageToken` returned by a previous list request to get
8117 the next page of results.
8118 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
8119 of failure. The default value is false.
8120
8121 For example, when partial success behavior is enabled, aggregatedList for a
8122 single zone scope either returns all resources in the zone or no resources,
8123 with an error code.
8124 x__xgafv: string, V1 error format.
8125 Allowed values
8126 1 - v1 error format
8127 2 - v2 error format
8128
8129 Returns:
8130 An object of the form:
8131
8132 { # Contains a list of BackendService resources.
8133 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
8134 &quot;items&quot;: [ # A list of BackendService resources.
8135 { # Represents a Backend Service resource.
8136 #
8137 # A backend service defines how Google Cloud load balancers distribute traffic.
8138 # The backend service configuration contains a set of values, such as the
8139 # protocol used to connect to backends, various distribution and session
8140 # settings, health checks, and timeouts. These settings provide fine-grained
8141 # control over how your load balancer behaves. Most of the settings have
8142 # default values that allow for easy configuration if you need to get started
8143 # quickly.
8144 #
8145 # Backend services in Google Compute Engine can be either regionally or
8146 # globally scoped.
8147 #
8148 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
8149 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
8150 #
8151 # For more information, seeBackend
8152 # Services.
8153 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
8154 # Load Balancers and Traffic Director and requires
8155 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
8156 #
8157 # If set to 0, the cookie is non-persistent and lasts only until
8158 # the end of the browser session (or equivalent). The maximum allowed value
8159 # is two weeks (1,209,600).
8160 #
8161 # Not supported when the backend service is referenced by a URL map that is
8162 # bound to target gRPC proxy that has validateForProxyless field set to true.
8163 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
8164 # load balancing scheme set to INTERNAL_SELF_MANAGED.
8165 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
8166 { # Message containing information of one individual backend.
8167 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
8168 # handle additional traffic or is fully loaded. For usage guidelines, see
8169 # Connection balancing mode.
8170 #
8171 # Backends must use compatible balancing modes. For more information, see
8172 # Supported balancing modes and target capacity settings and
8173 # Restrictions and guidance for instance groups.
8174 #
8175 # Note: Currently, if you use the API to configure incompatible balancing
8176 # modes, the configuration might be accepted even though it has no impact
8177 # and is ignored. Specifically, Backend.maxUtilization is ignored when
8178 # Backend.balancingMode is RATE. In the future, this incompatible combination
8179 # will be rejected.
8180 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
8181 # mode.
8182 # The default value is 1, which means the group serves up to
8183 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
8184 # completely drained, offering 0% of its available capacity. The valid ranges
8185 # are 0.0 and [0.1,1.0].
8186 # You cannot configure a setting larger than 0 and smaller than0.1.
8187 # You cannot configure a setting of 0 when there is only one
8188 # backend attached to the backend service.
8189 #
8190 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
8191 # internet NEGs, regional serverless NEGs, and PSC NEGs.
8192 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
8193 # BalancingMode.
8194 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
8195 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
8196 # Monitoring, but is not used for load balancing.
8197 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
8198 # balancing mode. The valid range is [0.0, 1.0].
8199 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8200 # long and match the regular expression
8201 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8202 # first character must be a lowercase letter, and all following
8203 # characters must be a dash, period, underscore, lowercase letter, or
8204 # digit, except the last character, which cannot be a dash, period, or
8205 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8206 # field can only be used for a global or regional backend service with the
8207 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8208 },
8209 ],
8210 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8211 # create the resource.
8212 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
8213 # failover backend can be configured for a given BackendService.
8214 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
8215 # group or network endpoint
8216 # group (NEG) resource. To determine what types of backends a load
8217 # balancer supports, see the [Backend services
8218 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
8219 #
8220 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
8221 # or NEG. Partial URLs are not supported.
8222 #
8223 # If haPolicy is specified, backends must refer to NEG resources of type
8224 # GCE_VM_IP.
8225 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8226 # guidelines, seeConnection
8227 # balancing mode and Utilization
8228 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
8229 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8230 # guidelines, seeConnection
8231 # balancing mode and Utilization
8232 # balancing mode.
8233 #
8234 # Not available if the backend&#x27;s balancingMode isRATE.
8235 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
8236 # For usage guidelines, seeConnection
8237 # balancing mode and Utilization
8238 # balancing mode.
8239 #
8240 # Not available if the backend&#x27;s balancingMode isRATE.
8241 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
8242 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
8243 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
8244 # Not available if backend&#x27;s balancingMode is RATE
8245 # or CONNECTION.
8246 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
8247 # Not available if backend&#x27;s balancingMode is RATE
8248 # or CONNECTION.
8249 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
8250 # usage guidelines, seeRate
8251 # balancing mode and Utilization
8252 # balancing mode.
8253 #
8254 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8255 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8256 # guidelines, seeRate
8257 # balancing mode and Utilization
8258 # balancing mode.
8259 #
8260 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8261 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8262 # guidelines, seeRate
8263 # balancing mode and Utilization
8264 # balancing mode.
8265 #
8266 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8267 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
8268 #
8269 # For usage guidelines, seeUtilization
8270 # balancing mode.
8271 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
8272 # the backend.
8273 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
8274 },
8275 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
8276 # sending traffic to backends with default preference. The possible values
8277 # are:
8278 #
8279 # - PREFERRED: Backends with this preference level will be
8280 # filled up to their capacity limits first, based on RTT.
8281 # - DEFAULT: If preferred backends don&#x27;t have enough
8282 # capacity, backends in this layer would be used and traffic would be
8283 # assigned based on the load balancing algorithm you use. This is the
8284 # default
8285 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
8286 # Attachment).
8287 # e.g.
8288 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
8289 # for Cloud Run service.
8290 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
8291 # for PSC Service Attachment.
8292 &quot;trafficDuration&quot;: &quot;A String&quot;,
8293 },
8294 ],
8295 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
8296 # specified load balancer types.
8297 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
8298 # Pragma or Authorization headers. Up to 5 headers can be specified.
8299 # The cache is bypassed for all cdnPolicy.cacheMode settings.
8300 { # Bypass the cache when the specified request headers are present,
8301 # e.g. Pragma or Authorization headers. Values are case insensitive.
8302 # The presence of such a header overrides the cache_mode setting.
8303 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
8304 # Values are case-insensitive.
8305 },
8306 ],
8307 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
8308 # CDN.
8309 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
8310 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
8311 &quot;A String&quot;,
8312 ],
8313 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
8314 # The name=value pair will be used in the cache key Cloud CDN generates.
8315 &quot;A String&quot;,
8316 ],
8317 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
8318 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
8319 # query_string_whitelist and query_string_blacklist. If neither is set, the
8320 # entire query string will be included. If false, the query string will be
8321 # excluded from the cache key entirely.
8322 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
8323 # parameters will be included. Either specify query_string_whitelist or
8324 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8325 # not treated as delimiters.
8326 &quot;A String&quot;,
8327 ],
8328 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
8329 # parameters will be excluded. Either specify query_string_whitelist or
8330 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8331 # not treated as delimiters.
8332 &quot;A String&quot;,
8333 ],
8334 },
8335 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
8336 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
8337 # headers to cache content. Responses without these headers will not be
8338 # cached at Google&#x27;s edge, and will require a full trip to the origin on
8339 # every request, potentially impacting performance and increasing load on
8340 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
8341 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
8342 # Warning: this may result in Cloud CDN caching private,
8343 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
8344 # including common image formats, media (video and audio), and web assets
8345 # (JavaScript and CSS). Requests and responses that are marked as
8346 # uncacheable, as well as dynamic content (including HTML), will not be
8347 # cached.
8348 #
8349 # If no value is provided for cdnPolicy.cacheMode, it defaults
8350 # to CACHE_ALL_STATIC.
8351 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
8352 # used to clamp the max-age (or Expires) value sent to the client. With
8353 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
8354 # response max-age directive, along with a &quot;public&quot; directive. For
8355 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
8356 # from the origin (if specified), or else sets the response max-age
8357 # directive to the lesser of the client_ttl and default_ttl, and also
8358 # ensures a &quot;public&quot; cache-control directive is present.
8359 # If a client TTL is not specified, a default value (1 hour) will be used.
8360 # The maximum allowed value is 31,622,400s (1 year).
8361 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
8362 # responses that do not have an existing valid TTL (max-age or s-maxage).
8363 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8364 # The value of defaultTTL cannot be set to a value greater than that of
8365 # maxTTL, but can be equal.
8366 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
8367 # will overwrite the TTL set in all responses. The maximum allowed value is
8368 # 31,622,400s (1 year), noting that infrequently accessed objects may be
8369 # evicted from the cache before the defined TTL.
8370 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
8371 # origin.
8372 # Cache directives that attempt to set a max-age or s-maxage higher than
8373 # this, or an Expires header more than maxTTL seconds in the future will
8374 # be capped at the value of maxTTL, as if it were the value of an
8375 # s-maxage Cache-Control directive.
8376 # Headers sent to the client will not be modified.
8377 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8378 # The maximum allowed value is 31,622,400s (1 year), noting that
8379 # infrequently accessed objects may be evicted from the cache before
8380 # the defined TTL.
8381 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
8382 # to apply fine-grained caching for common errors or redirects.
8383 # This can reduce the load on your origin and improve end-user
8384 # experience by reducing response latency.
8385 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
8386 # negative caching applies to responses with the specified response code
8387 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
8388 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
8389 # to all responses with the specified response code, and override any
8390 # caching headers.
8391 # By default, Cloud CDN will apply the following default TTLs to these
8392 # status codes:
8393 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
8394 # HTTP 404 (Not Found), 410 (Gone),
8395 # 451 (Unavailable For Legal Reasons): 120s
8396 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
8397 # These defaults can be overridden in negative_caching_policy.
8398 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
8399 # negative_caching must be enabled to configure negative_caching_policy.
8400 # Omitting the policy and leaving negative_caching enabled will use
8401 # Cloud CDN&#x27;s default cache TTLs.
8402 # Note that when specifying an explicit negative_caching_policy, you
8403 # should take care to specify a cache TTL for all response codes
8404 # that you wish to cache. Cloud CDN will not apply any default
8405 # negative caching when a policy exists.
8406 { # Specify CDN TTLs for response error codes.
8407 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
8408 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
8409 # specified as values, and you cannot specify a status code more than
8410 # once.
8411 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
8412 # corresponding status code.
8413 # The maximum allowed value is 1800s (30 minutes), noting that
8414 # infrequently accessed objects may be evicted from the cache before the
8415 # defined TTL.
8416 },
8417 ],
8418 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
8419 # requests into a small number of requests to the origin.
8420 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
8421 # content with the origin, or when an error is encountered when refreshing
8422 # the cache.
8423 # This setting defines the default &quot;max-stale&quot; duration for any cached
8424 # responses that do not specify a max-stale directive. Stale responses that
8425 # exceed the TTL configured here will not be served. The default limit
8426 # (max-stale) is 86400s (1 day), which will allow stale content to be
8427 # served up to this limit beyond the max-age (or s-maxage) of a cached
8428 # response.
8429 # The maximum allowed value is 604800 (1 week).
8430 # Set this to zero (0) to disable serve-while-stale.
8431 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
8432 # considered fresh. After this time period, the response will be
8433 # revalidated before being served. Defaults to 1hr (3600s). When serving
8434 # responses to signed URL requests, Cloud CDN will internally behave as
8435 # though all responses from this backend had a &quot;Cache-Control:
8436 # public, max-age=[TTL]&quot; header, regardless of any existing
8437 # Cache-Control header. The actual headers served in responses will not be
8438 # altered.
8439 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
8440 &quot;A String&quot;,
8441 ],
8442 },
8443 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
8444 # backend service.
8445 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
8446 # as a count of seconds and fractions of seconds at nanosecond
8447 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8448 # or &quot;month&quot;. Range is approximately 10,000 years.
8449 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8450 # Durations less than one second are represented with a 0
8451 # `seconds` field and a positive `nanos` field. Must be from 0
8452 # to 999,999,999 inclusive.
8453 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8454 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8455 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8456 },
8457 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
8458 # there is no limit.
8459 #
8460 # Not supported when the backend service is referenced by a URL map that is
8461 # bound to target gRPC proxy that has validateForProxyless field set to true.
8462 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
8463 # not specified, there is no limit.
8464 #
8465 # Not supported when the backend service is referenced by a URL map that is
8466 # bound to target gRPC proxy that has validateForProxyless field set to true.
8467 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
8468 # service. If not specified, there is no limit.
8469 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
8470 # This parameter is respected by both the HTTP/1.1 and HTTP/2
8471 # implementations. If not specified, there is no limit. Setting this
8472 # parameter to 1 will effectively disable keep alive.
8473 #
8474 # Not supported when the backend service is referenced by a URL map that is
8475 # bound to target gRPC proxy that has validateForProxyless field set to true.
8476 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
8477 # not specified, the default is 1.
8478 #
8479 # Not supported when the backend service is referenced by a URL map that is
8480 # bound to target gRPC proxy that has validateForProxyless field set to true.
8481 },
8482 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
8483 # the client&#x27;s Accept-Encoding header.
8484 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
8485 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
8486 # instance. For supported load balancers and protocols, as described inEnabling
8487 # connection draining.
8488 },
8489 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
8490 # tracking policy settings are only available for external passthrough
8491 # Network Load Balancers and internal passthrough Network Load Balancers.
8492 #
8493 # connectionTrackingPolicy cannot be specified with haPolicy.
8494 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
8495 # value is DEFAULT_FOR_PROTOCOL.
8496 #
8497 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
8498 # persist on unhealthy backends only for connection-oriented protocols
8499 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
8500 # Affinity is configured for 5-tuple. They do not persist forUDP.
8501 #
8502 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
8503 # the existing connections on the unhealthy backend are never persisted on
8504 # the unhealthy backend. They are always diverted to newly selected healthy
8505 # backends (unless all backends are unhealthy).
8506 #
8507 # If set to ALWAYS_PERSIST, existing connections always
8508 # persist on unhealthy backends regardless of protocol and session
8509 # affinity. It is generally not recommended to use this mode overriding the
8510 # default.
8511 #
8512 # For more details, see [Connection Persistence for Network Load
8513 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
8514 # and [Connection Persistence for Internal TCP/UDP Load
8515 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
8516 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
8517 # Balancers. This option is not available publicly.
8518 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
8519 # matching traffic (in seconds).
8520 #
8521 # For internal passthrough Network Load Balancers:
8522 #
8523 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
8524 # - It can be set only if Connection Tracking is less than 5-tuple
8525 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
8526 # Mode is PER_SESSION).
8527 #
8528 #
8529 #
8530 # For external passthrough Network Load Balancers the default is 60
8531 # seconds. This option is not available publicly.
8532 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
8533 # options:
8534 #
8535 # - PER_CONNECTION: This is the default mode. The Connection
8536 # Tracking is performed as per the Connection Key (default Hash Method) for
8537 # the specific protocol.
8538 # - PER_SESSION: The Connection Tracking is performed as per
8539 # the configured Session Affinity. It matches the configured Session
8540 # Affinity.
8541 #
8542 #
8543 #
8544 # For more details, see [Tracking Mode for Network Load
8545 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
8546 # and [Tracking Mode for Internal TCP/UDP Load
8547 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
8548 },
8549 &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
8550 # affinity based on HTTP headers, cookies or other properties. This load
8551 # balancing policy is applicable only for HTTP connections. The affinity to a
8552 # particular destination host will be lost when one or more hosts are
8553 # added/removed from the destination service. This field specifies parameters
8554 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
8555 #
8556 # This field is applicable to either:
8557 #
8558 # - A regional backend service with the service protocol set to HTTP,
8559 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
8560 # INTERNAL_MANAGED.
8561 # - A global backend service with the
8562 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
8563 &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
8564 # be used as the hash key for the consistent hash load balancer. If the
8565 # cookie is not present, it will be generated. This field is applicable if
8566 # the sessionAffinity is set to HTTP_COOKIE.
8567 #
8568 # Not supported when the backend service is referenced by a URL map that is
8569 # bound to target gRPC proxy that has validateForProxyless field set to true.
8570 # for load balancing policies that use a consistent hash.
8571 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8572 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8573 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8574 # as a count of seconds and fractions of seconds at nanosecond
8575 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8576 # or &quot;month&quot;. Range is approximately 10,000 years.
8577 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8578 # Durations less than one second are represented with a 0
8579 # `seconds` field and a positive `nanos` field. Must be from 0
8580 # to 999,999,999 inclusive.
8581 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8582 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8583 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8584 },
8585 },
8586 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
8587 # applicable if the sessionAffinity is set toHEADER_FIELD.
8588 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
8589 # 1024. Larger ring sizes result in more granular load distributions. If the
8590 # number of hosts in the load balancing pool is larger than the ring size,
8591 # each host will be assigned a single virtual node.
8592 },
8593 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8594 # text format.
8595 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
8596 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
8597 # locality_lb_policy.
8598 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
8599 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8600 # long and match the regular expression
8601 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8602 # first character must be a lowercase letter, and all following
8603 # characters must be a dash, period, underscore, lowercase letter, or
8604 # digit, except the last character, which cannot be a dash, period, or
8605 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8606 # field can only be used for a global or regional backend service with the
8607 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8608 },
8609 ],
8610 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
8611 # custom
8612 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
8613 &quot;A String&quot;,
8614 ],
8615 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
8616 # custom
8617 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
8618 &quot;A String&quot;,
8619 ],
8620 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8621 # create the resource.
8622 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
8623 # backend service with dynamic forwarding feature which together with Service
8624 # Extension allows customized and complex routing logic.
8625 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
8626 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
8627 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
8628 },
8629 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
8630 # service. Some ranges are restricted: Restricted
8631 # ranges.
8632 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
8633 },
8634 },
8635 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
8636 # this backend service.
8637 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
8638 # global external Application Load Balancer.
8639 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
8640 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
8641 #
8642 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
8643 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
8644 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
8645 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
8646 # externalManagedMigrationTestingPercentage.
8647 #
8648 # Rolling back a migration requires the states to be set in reverse order. So
8649 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
8650 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
8651 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
8652 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
8653 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
8654 # external Application Load Balancer.
8655 #
8656 # The value of this field must be in the range [0, 100].
8657 #
8658 # Session affinity options will slightly affect this routing behavior, for
8659 # more details, see:Session
8660 # Affinity.
8661 #
8662 # This value can only be set if the loadBalancingScheme in the BackendService
8663 # is set to EXTERNAL (when using the classic Application Load Balancer) and
8664 # the migration state is TEST_BY_PERCENTAGE.
8665 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
8666 # as a backup (failover) backend.
8667 # For load balancers that have configurable failover:
8668 # [Internal passthrough Network Load
8669 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8670 # and [external passthrough Network Load
8671 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8672 #
8673 # failoverPolicy cannot be specified with haPolicy.
8674 # failover:
8675 # [Internal passthrough Network Load
8676 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8677 # and [external passthrough
8678 # Network Load
8679 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8680 # On failover or failback, this field indicates whether connection draining
8681 # will be honored. Google Cloud has a fixed connection draining timeout of
8682 # 10 minutes. A setting of true terminates existing TCP
8683 # connections to the active pool during failover and failback, immediately
8684 # draining traffic. A setting of false allows existing TCP
8685 # connections to persist, even on VMs no longer in the active pool, for up
8686 # to the duration of the connection draining timeout (10 minutes).
8687 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
8688 #
8689 # The default is false.
8690 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
8691 # load balancer are dropped when all primary and all backup backend VMs are
8692 # unhealthy.If set to false, connections are distributed
8693 # among all primary VMs when all primary and all backup backend VMs are
8694 # unhealthy.
8695 # For load balancers that have configurable
8696 # failover:
8697 # [Internal passthrough
8698 # Network Load
8699 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8700 # and [external passthrough
8701 # Network Load
8702 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8703 # The default is false.
8704 &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
8705 # failover when the number of healthy primary VMs equals zero.
8706 # For all other values, the load balancer performs a failover when the
8707 # total number of healthy primary VMs is less than this ratio.
8708 # For load balancers that have configurable
8709 # failover:
8710 # [Internal TCP/UDP Load
8711 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8712 # and [external TCP/UDP Load
8713 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8714 },
8715 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
8716 # This field is used in optimistic locking. This field will be ignored when
8717 # inserting a BackendService. An up-to-date fingerprint must be provided in
8718 # order to update the BackendService, otherwise the request will
8719 # fail with error 412 conditionNotMet.
8720 #
8721 # To see the latest fingerprint, make a get() request to
8722 # retrieve a BackendService.
8723 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
8724 # Protocol Forwarding.
8725 #
8726 # The backends of this regional backend service must only specify zonal
8727 # network endpoint groups (NEGs) of type GCE_VM_IP.
8728 #
8729 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
8730 # regional backend service must set the network field. All zonal NEGs must
8731 # belong to the same network. However, individual NEGs can
8732 # belong to different subnetworks of that network.
8733 #
8734 # When haPolicy is specified, the set of attached network endpoints across
8735 # all backends comprise an High Availability domain from which one endpoint
8736 # is selected as the active endpoint (the leader) that receives all
8737 # traffic.
8738 #
8739 # haPolicy can be added only at backend service creation time. Once set up,
8740 # it cannot be deleted.
8741 #
8742 # Note that haPolicy is not for load balancing, and therefore cannot be
8743 # specified with sessionAffinity, connectionTrackingPolicy, and
8744 # failoverPolicy.
8745 #
8746 # haPolicy requires customers to be responsible for tracking backend
8747 # endpoint health and electing a leader among the healthy endpoints.
8748 # Therefore, haPolicy cannot be specified with healthChecks.
8749 #
8750 # haPolicy can only be specified for External Passthrough Network Load
8751 # Balancers and Internal Passthrough Network Load Balancers.
8752 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
8753 # achieve it.
8754 #
8755 # Supported values are:
8756 #
8757 # - DISABLED: Fast IP Move is disabled. You can only use the
8758 # haPolicy.leader API to update the leader.
8759 # - &gt;GARP_RA: Provides a method to very quickly define a new network
8760 # endpoint as the leader. This method is faster than updating the leader
8761 # using the haPolicy.leader API. Fast IP move works as follows: The VM
8762 # hosting the network endpoint that should become the new leader sends
8763 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
8764 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
8765 # temporarily associates the forwarding rule IP address with that VM, and
8766 # both new and in-flight packets are quickly delivered to that VM.
8767 #
8768 #
8769 #
8770 # Note the important properties of the Fast IP Move functionality:
8771 #
8772 # - The GARP/RA-initiated re-routing stays active for approximately 20
8773 # minutes. After triggering fast failover, you must also
8774 # appropriately set the haPolicy.leader.
8775 # - The new leader instance should continue to send GARP/RA packets
8776 # periodically every 10 seconds until at least 10 minutes after updating
8777 # the haPolicy.leader (but stop immediately if it is no longer the leader).
8778 # - After triggering a fast failover, we recommend that you wait at least
8779 # 3 seconds before sending another GARP/RA packet from a different VM
8780 # instance to avoid race conditions.
8781 # - Don&#x27;t send GARP/RA packets from different VM
8782 # instances at the same time. If multiple instances continue to send
8783 # GARP/RA packets, traffic might be routed to different destinations in an
8784 # alternating order. This condition ceases when a single instance
8785 # issues a GARP/RA packet.
8786 # - The GARP/RA request always takes priority over the leader API.
8787 # Using the haPolicy.leader API to change the leader to a different
8788 # instance will have no effect until the GARP/RA request becomes
8789 # inactive.
8790 # - The GARP/RA packets should follow the GARP/RA
8791 # Packet Specifications..
8792 # - When multiple forwarding rules refer to a regional backend service,
8793 # you need only send a GARP or RA packet for a single forwarding rule
8794 # virtual IP. The virtual IPs for all forwarding rules targeting the same
8795 # backend service will also be moved to the sender of the GARP or RA
8796 # packet.
8797 #
8798 #
8799 #
8800 # The following are the Fast IP Move limitations (that is, when fastIPMove
8801 # is not DISABLED):
8802 #
8803 # - Multiple forwarding rules cannot use the same IP address if one of
8804 # them refers to a regional backend service with fastIPMove.
8805 # - The regional backend service must set the network field, and all
8806 # NEGs must belong to that network. However, individual
8807 # NEGs can belong to different subnetworks of that network.
8808 # - The maximum number of network endpoints across all backends of a
8809 # backend service with fastIPMove is 32.
8810 # - The maximum number of backend services with fastIPMove that can have
8811 # the same network endpoint attached to one of its backends is 64.
8812 # - The maximum number of backend services with fastIPMove in a VPC in a
8813 # region is 64.
8814 # - The network endpoints that are attached to a backend of a backend
8815 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
8816 # - Traffic directed to the leader by a static route next hop will not be
8817 # redirected to a new leader by fast failover. Such traffic will only be
8818 # redirected once an haPolicy.leader update has taken effect. Only traffic
8819 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
8820 # fast failover.
8821 #
8822 #
8823 # haPolicy.fastIPMove can be set only at backend service creation time.
8824 # Once set, it cannot be updated.
8825 #
8826 # By default, fastIpMove is set to DISABLED.
8827 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
8828 # this service as the active endpoint (the leader) that receives all
8829 # traffic.
8830 #
8831 # When the leader changes, there is no connection draining to persist
8832 # existing connections on the old leader.
8833 #
8834 # You are responsible for selecting a suitable endpoint as the
8835 # leader. For example, preferring a healthy endpoint over unhealthy ones.
8836 # Note that this service does not track backend endpoint health, and
8837 # selects the configured leader unconditionally.
8838 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
8839 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
8840 # that the leader is attached to.
8841 #
8842 # The leader&#x27;s backendGroup must already be specified as a backend of
8843 # this backend service. Removing a backend that is designated as the
8844 # leader&#x27;s backendGroup is not permitted.
8845 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
8846 # designated as the leader.
8847 #
8848 # This network endpoint cannot be detached from the NEG specified in
8849 # the haPolicy.leader.backendGroup until the leader is updated with
8850 # another network endpoint, or the leader is removed from the haPolicy.
8851 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
8852 # instance must already be attached to the NEG specified in the
8853 # haPolicy.leader.backendGroup.
8854 #
8855 # The name must be 1-63 characters long, and comply with RFC1035.
8856 # Authorization requires the following IAM permission on the
8857 # specified resource instance: compute.instances.use
8858 },
8859 },
8860 },
8861 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
8862 # httpsHealthChecks (legacy) resource for health checking this backend
8863 # service. Not all backend services support legacy health checks. See
8864 # Load balancer guide. Currently, at most one health check can be
8865 # specified for each backend service. Backend services with
8866 # instance group or zonal NEG backends must have a health check unless
8867 # haPolicy is specified. Backend services with internet or serverless NEG
8868 # backends must not have a health check.
8869 #
8870 # healthChecks[] cannot be specified with haPolicy.
8871 &quot;A String&quot;,
8872 ],
8873 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
8874 # Not available for internal passthrough Network Load Balancers and external
8875 # passthrough Network Load Balancers.
8876 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
8877 # incoming requests.
8878 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
8879 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
8880 # for IAP.
8881 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
8882 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
8883 # Optional - If not provided, the name will be autogenerated by the
8884 # backend.
8885 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
8886 },
8887 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
8888 # For security reasons, this value cannot be retrieved via the API.
8889 # Instead, the SHA-256 hash of the value is returned in the
8890 # oauth2ClientSecretSha256 field.
8891 #
8892 # @InputOnly
8893 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
8894 },
8895 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
8896 # defined by the server.
8897 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
8898 # from the client to the backend for proxyless gRPC).
8899 # The possible values are:
8900 #
8901 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
8902 # backend service (Instance Group, Managed Instance Group, Network Endpoint
8903 # Group), regardless of traffic from the client to the proxy. Only IPv4
8904 # health checks are used to check the health of the backends. This is the
8905 # default setting.
8906 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
8907 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
8908 # address).
8909 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
8910 # backend service (Instance Group, Managed Instance Group, Network Endpoint
8911 # Group), regardless of traffic from the client to the proxy. Only IPv6
8912 # health checks are used to check the health of the backends.
8913 #
8914 #
8915 #
8916 # This field is applicable to either:
8917 #
8918 # - Advanced global external Application Load Balancer (load balancing
8919 # scheme EXTERNAL_MANAGED),
8920 # - Regional external Application Load
8921 # Balancer,
8922 # - Internal proxy Network Load Balancer (load balancing
8923 # scheme INTERNAL_MANAGED),
8924 # - Regional internal Application Load
8925 # Balancer (load balancing scheme INTERNAL_MANAGED),
8926 # - Traffic
8927 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
8928 # INTERNAL_SELF_MANAGED).
8929 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
8930 # for backend services.
8931 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
8932 # created for one type of load balancer cannot be used with another.
8933 # For more information, refer toChoosing
8934 # a load balancer.
8935 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
8936 # preference. When you use localityLbPolicies, you must set at least one
8937 # value for either the localityLbPolicies[].policy or the
8938 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
8939 # value set in the localityLbPolicy field.
8940 #
8941 # For an example of how to use this field, seeDefine
8942 # a list of preferred policies.
8943 #
8944 # Caution: This field and its children are intended for use in a service mesh
8945 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
8946 # that have this configuration.
8947 { # Container for either a built-in LB policy supported by gRPC or Envoy or
8948 # a custom one implemented by the end user.
8949 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
8950 # deployed with the client.
8951 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
8952 # by a locally installed custom policy implementation.
8953 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
8954 #
8955 # The value should match the name of a custom implementation registered
8956 # on the gRPC clients. It should follow protocol buffer message naming
8957 # conventions and include the full path (for example,
8958 # myorg.CustomLbPolicy). The maximum length is 256 characters.
8959 #
8960 # Do not specify the same custom policy more than once for a
8961 # backend. If you do, the configuration is rejected.
8962 #
8963 # For an example of how to use this field, seeUse
8964 # a custom policy.
8965 },
8966 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
8967 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
8968 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
8969 # about these values, see the description of localityLbPolicy.
8970 #
8971 # Do not specify the same policy more than once for a
8972 # backend. If you do, the configuration is rejected.
8973 },
8974 },
8975 ],
8976 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
8977 # possible values are:
8978 #
8979 # - ROUND_ROBIN: This is a simple policy in which each healthy
8980 # backend is selected in round robin order. This is the default.
8981 # - LEAST_REQUEST: An O(1) algorithm which
8982 # selects two random healthy hosts and picks the host which has fewer active
8983 # requests.
8984 # - RING_HASH: The ring/modulo hash load balancer implements
8985 # consistent hashing to backends. The algorithm has the property that the
8986 # addition/removal of a host from a set of N hosts only affects 1/N of the
8987 # requests.
8988 # - RANDOM: The load balancer selects a random healthy
8989 # host.
8990 # - ORIGINAL_DESTINATION: Backend host is selected
8991 # based on the client connection metadata, i.e., connections are opened to
8992 # the same address as the destination address of the incoming connection
8993 # before the connection was redirected to the load balancer.
8994 # - MAGLEV: used as a drop in replacement for the ring hash
8995 # load balancer. Maglev is not as stable as ring hash but has faster table
8996 # lookup build times and host selection times. For more information about
8997 # Maglev, see Maglev:
8998 # A Fast and Reliable Software Network Load Balancer.
8999 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
9000 # Load Balancing using weights computed from Backend reported Custom Metrics.
9001 # If set, the Backend Service responses are expected to contain non-standard
9002 # HTTP response header field Endpoint-Load-Metrics. The reported
9003 # metrics to use for computing the weights are specified via thecustomMetrics field.
9004 #
9005 # This field is applicable to either:
9006 # - A regional backend service with the service protocol set to HTTP,
9007 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
9008 # INTERNAL_MANAGED.
9009 # - A global backend service with the
9010 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
9011 # EXTERNAL_MANAGED.
9012 #
9013 #
9014 # If sessionAffinity is not configured—that is, if session
9015 # affinity remains at the default value of NONE—then the
9016 # default value for localityLbPolicy
9017 # is ROUND_ROBIN. If session affinity is set to a value other
9018 # than NONE,
9019 # then the default value for localityLbPolicy isMAGLEV.
9020 #
9021 # Only ROUND_ROBIN and RING_HASH are supported
9022 # when the backend service is referenced by a URL map that is bound to
9023 # target gRPC proxy that has validateForProxyless field set to true.
9024 #
9025 # localityLbPolicy cannot be specified with haPolicy.
9026 &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
9027 # by this backend service. If logging is enabled, logs will be exported to
9028 # Stackdriver.
9029 # backend service.
9030 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
9031 # traffic served by this backend service. The default value is false.
9032 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
9033 { # Determines which HTTP headers will be logged to Stackdriver.
9034 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9035 },
9036 ],
9037 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
9038 { # Determines which HTTP headers will be logged to Stackdriver.
9039 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9040 },
9041 ],
9042 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
9043 # This field can only be specified if logging is enabled for this backend
9044 # service. Configures whether all, none or a subset of optional fields
9045 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
9046 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
9047 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
9048 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
9049 # of optional fields you want to include in the logs. For example:
9050 # serverInstance, serverGkeDetails.cluster,
9051 # serverGkeDetails.pod.podNamespace
9052 &quot;A String&quot;,
9053 ],
9054 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
9055 # service. Configures whether all, none or a subset of optional fields
9056 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
9057 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
9058 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
9059 # service. The value of the field must be in [0, 1]. This configures the
9060 # sampling rate of requests to the load balancer where 1.0 means all logged
9061 # requests are reported and 0.0 means no logged requests are reported. The
9062 # default value is 1.0.
9063 },
9064 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
9065 # service. Duration is computed from the beginning of the stream until the
9066 # response has been completely processed, including all retries. A stream
9067 # that does not complete in this duration is closed.
9068 #
9069 # If not specified, there will be no timeout limit, i.e. the maximum
9070 # duration is infinite.
9071 #
9072 # This value can be overridden in the PathMatcher configuration of the
9073 # UrlMap that references this backend service.
9074 #
9075 # This field is only allowed when the loadBalancingScheme of
9076 # the backend service is INTERNAL_SELF_MANAGED.
9077 # as a count of seconds and fractions of seconds at nanosecond
9078 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9079 # or &quot;month&quot;. Range is approximately 10,000 years.
9080 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9081 # Durations less than one second are represented with a 0
9082 # `seconds` field and a positive `nanos` field. Must be from 0
9083 # to 999,999,999 inclusive.
9084 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9085 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9086 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9087 },
9088 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
9089 # controller and read by the backend RCTH
9090 &quot;a_key&quot;: &quot;A String&quot;,
9091 },
9092 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
9093 # The name must be 1-63 characters long, and comply withRFC1035.
9094 # Specifically, the name must be 1-63 characters long and match the regular
9095 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
9096 # character must be a lowercase letter, and all following characters must
9097 # be a dash, lowercase letter, or digit, except the last character, which
9098 # cannot be a dash.
9099 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
9100 #
9101 # This field must be set for Internal Passthrough Network Load Balancers when
9102 # the haPolicy is enabled, and for External Passthrough Network Load
9103 # Balancers when the haPolicy fastIpMove is enabled.
9104 #
9105 # 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.
9106 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
9107 # Load Balancers.
9108 #
9109 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
9110 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
9111 # endpoints in the local zone.
9112 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
9113 # possible values are:
9114 #
9115 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
9116 # is disabled. The load balancer distributes new connections to all
9117 # healthy backend endpoints across all zones.
9118 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
9119 # enabled. The load balancer distributes new connections to all healthy
9120 # backend endpoints in the local zone only. If there are no healthy
9121 # backend endpoints in the local zone, the load balancer distributes
9122 # new connections to all backend endpoints in the local zone.
9123 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
9124 # enabled. The load balancer distributes new connections to all healthy
9125 # backend endpoints in the local zone only. If there aren&#x27;t enough
9126 # healthy backend endpoints in the local zone, the load balancer
9127 # distributes new connections to all healthy backend endpoints across all
9128 # zones.
9129 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
9130 # of healthy backend endpoints in a zone to the count of backend
9131 # endpoints in that same zone is equal to or above this threshold, the
9132 # load balancer distributes new connections to all healthy endpoints in
9133 # the local zone only. When the ratio of the count of healthy backend
9134 # endpoints in a zone to the count of backend endpoints in that same
9135 # zone is below this threshold, the load balancer distributes all new
9136 # connections to all healthy endpoints across all zones.
9137 },
9138 },
9139 &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.
9140 # the backend service.
9141 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
9142 # service.
9143 },
9144 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
9145 # load balancing pool of each individual proxy instance that processes the
9146 # traffic for the given backend service. If not set, this feature is
9147 # considered disabled.
9148 #
9149 # Results of the outlier detection algorithm (ejection of endpoints from the
9150 # load balancing pool and returning them back to the pool) are executed
9151 # independently by each proxy instance of the load balancer. In most cases,
9152 # more than one proxy instance handles the traffic received by a backend
9153 # service. Thus, it is possible that an unhealthy endpoint is detected and
9154 # ejected by only some of the proxies, and while this happens, other proxies
9155 # may continue to send requests to the same unhealthy endpoint until they
9156 # detect and eject the unhealthy endpoint.
9157 #
9158 # Applicable backend endpoints can be:
9159 #
9160 # - VM instances in an Instance Group
9161 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
9162 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
9163 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
9164 # Functions Services
9165 # - Private Service Connect NEGs, that resolve to
9166 # Google-managed regional API endpoints or managed services published using
9167 # Private Service Connect
9168 #
9169 #
9170 #
9171 # Applicable backend service types can be:
9172 #
9173 # - A global backend service with the loadBalancingScheme set to
9174 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
9175 # - A regional backend
9176 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
9177 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
9178 # supported for Serverless NEGs.
9179 #
9180 #
9181 #
9182 # Not supported when the backend service is referenced by a URL map that is
9183 # bound to target gRPC proxy that has validateForProxyless field set to true.
9184 # pool for the backend service.
9185 &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
9186 # or 30s.
9187 #
9188 # After a backend endpoint is returned back to the load balancing pool, it
9189 # can be ejected again in another ejection analysis. Thus, the total ejection
9190 # time is equal to the base ejection time multiplied by the number of times
9191 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
9192 # as a count of seconds and fractions of seconds at nanosecond
9193 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9194 # or &quot;month&quot;. Range is approximately 10,000 years.
9195 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9196 # Durations less than one second are represented with a 0
9197 # `seconds` field and a positive `nanos` field. Must be from 0
9198 # to 999,999,999 inclusive.
9199 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9200 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9201 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9202 },
9203 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
9204 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
9205 # return code qualifies as an error. Defaults to 5.
9206 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
9207 # connection errors that are mapped to one of those status codes) before a
9208 # consecutive gateway failure ejection occurs. Defaults to 3.
9209 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9210 # outlier status is detected through consecutive 5xx. This setting can be
9211 # used to disable ejection or to ramp it up slowly. Defaults to 0.
9212 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9213 # outlier status is detected through consecutive gateway failures. This
9214 # setting can be used to disable ejection or to ramp it up slowly. Defaults
9215 # to 100.
9216 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9217 # outlier status is detected through success rate statistics. This setting
9218 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
9219 #
9220 # Not supported when the backend service uses Serverless NEG.
9221 &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
9222 # ejections and backend endpoints being returned to service. The interval is
9223 # equal to the number of seconds as defined in
9224 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
9225 # in outlierDetection.interval.nanos. Defaults to 1 second.
9226 # as a count of seconds and fractions of seconds at nanosecond
9227 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9228 # or &quot;month&quot;. Range is approximately 10,000 years.
9229 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9230 # Durations less than one second are represented with a 0
9231 # `seconds` field and a positive `nanos` field. Must be from 0
9232 # to 999,999,999 inclusive.
9233 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9234 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9235 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9236 },
9237 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
9238 # backend service that can be ejected if the ejection conditions are met.
9239 # Defaults to 50%.
9240 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
9241 # enough request volume to detect success rate outliers. If the number of
9242 # backend endpoints is fewer than this setting, outlier detection via success
9243 # rate statistics is not performed for any backend endpoint in the load
9244 # balancing pool. Defaults to 5.
9245 #
9246 # Not supported when the backend service uses Serverless NEG.
9247 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
9248 # (as defined by the interval duration above) to include this backend
9249 # endpoint in success rate based outlier detection. If the volume is lower
9250 # than this setting, outlier detection via success rate statistics is not
9251 # performed for that backend endpoint. Defaults to 100.
9252 #
9253 # Not supported when the backend service uses Serverless NEG.
9254 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
9255 # outlier ejection. The ejection threshold is the difference between the mean
9256 # success rate, and the product of this factor and the standard deviation of
9257 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
9258 # is divided by a thousand to get a double. That is, if the desired factor
9259 # is 1.9, the runtime value should be 1900. Defaults to 1900.
9260 #
9261 # Not supported when the backend service uses Serverless NEG.
9262 },
9263 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
9264 # as part of resource payload.
9265 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
9266 # Tag keys and values have the same definition as resource
9267 # manager tags. The field is allowed for INSERT
9268 # only. The keys/values to set on the resource should be specified in
9269 # either ID { : } or Namespaced format
9270 # { : }.
9271 # For example the following are valid inputs:
9272 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
9273 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
9274 # Note:
9275 # * Invalid combinations of ID &amp; namespaced format is not supported. For
9276 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
9277 &quot;a_key&quot;: &quot;A String&quot;,
9278 },
9279 },
9280 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
9281 # the backend. The default value is 80.
9282 # For internal passthrough Network Load Balancers and external passthrough
9283 # Network Load Balancers, omit port.
9284 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
9285 # communication to the backend VMs in that group. The
9286 # named port must be [defined on each backend instance
9287 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
9288 # This parameter has no meaning if the backends are NEGs. For internal
9289 # passthrough Network Load Balancers and external passthrough Network Load
9290 # Balancers, omit port_name.
9291 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
9292 # with backends.
9293 #
9294 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
9295 # depending on the chosen load balancer or Traffic Director configuration.
9296 # Refer to the documentation for the load balancers or for Traffic Director
9297 # for more information.
9298 #
9299 # Must be set to GRPC when the backend service is referenced by a URL map
9300 # that is bound to target gRPC proxy.
9301 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
9302 # resides. This field is not applicable to global backend services.
9303 # You must specify this field as part of the HTTP request URL. It is
9304 # not settable as a field in the request body.
9305 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
9306 # backend service.
9307 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
9308 # service. This field is applicable to a global backend service with the
9309 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
9310 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
9311 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
9312 # be accepted on backends, and if authenticated, which method/certificate
9313 # will set the request principal.
9314 # request principal.
9315 # The authentication settings for the backend service.
9316 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
9317 # Similar to peers, these will be evaluated in order the first valid one
9318 # will be used to set origin identity. If none of these methods pass, the
9319 # request will be rejected with authentication failed error (401). Leave the
9320 # list empty if origin authentication is not required.
9321 { # [Deprecated] Configuration for the origin authentication method.
9322 # Configuration for the origin authentication method.
9323 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
9324 # JWT configuration for origin authentication.
9325 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
9326 # will be accepted if audiences is empty.
9327 # Examples: bookstore_android.apps.googleusercontent.com,
9328 # bookstore_web.apps.googleusercontent.com
9329 &quot;A String&quot;,
9330 ],
9331 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
9332 # email address.
9333 # Examples: https://securetoken.google.com,
9334 # [email protected]
9335 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
9336 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
9337 # request. If no explicit location is specified, the following default
9338 # locations are tried in order:
9339 #
9340 # 1. The Authorization header using the Bearer schema. See `here
9341 # `_. Example:
9342 #
9343 # Authorization: Bearer .
9344 #
9345 # 2. `access_token` query parameter. See `this
9346 # `_
9347 #
9348 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
9349 # from the locations its issuer specified or from the default locations.
9350 #
9351 # This field is set if JWT is sent in a request header. This field specifies
9352 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
9353 # header format will be x-goog-iap-jwt-assertion: .
9354 { # [Deprecated] This message specifies a header location to extract JWT token.
9355 # This message specifies a header location to extract JWT token.
9356 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
9357 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
9358 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
9359 # with a space at the end.
9360 },
9361 ],
9362 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
9363 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
9364 # JWT format in the query parameter is /path?jwt_token=.
9365 &quot;A String&quot;,
9366 ],
9367 },
9368 },
9369 ],
9370 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
9371 # They will be evaluated in order the first valid one will be used to set
9372 # peer identity. If none of these methods pass, the request will be rejected
9373 # with authentication failed error (401). Leave the list empty if peer
9374 # authentication is not required.
9375 { # [Deprecated] Configuration for the peer authentication method.
9376 # Configuration for the peer authentication method.
9377 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
9378 # Configuration for the mutual Tls mode for peer authentication.
9379 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
9380 # field can be set to one of the following:
9381 # STRICT: Client certificate must be presented, connection is in TLS.
9382 # PERMISSIVE: Client certificate can be omitted, connection can be either
9383 # plaintext or TLS.
9384 },
9385 },
9386 ],
9387 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
9388 # Default value is USE_PEER. If peer (or origin) identity is not available,
9389 # either because peer/origin authentication is not defined, or failed,
9390 # principal will be left unset. In other words, binding rule does not affect
9391 # the decision to accept or reject request. This field can be set to one of
9392 # the following:
9393 # USE_PEER: Principal will be set to the identity from peer authentication.
9394 # USE_ORIGIN: Principal will be set to the identity from origin
9395 # authentication.
9396 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
9397 # identity information.
9398 # The TLS settings for the client or server.
9399 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
9400 # certificate.
9401 # Defines the mechanism to obtain the client or server certificate.
9402 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
9403 # applicable only if tlsCertificateSource is set to USE_PATH.
9404 # The paths to the mounted TLS Certificates and private key.
9405 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9406 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9407 },
9408 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
9409 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
9410 # is applicable only if tlsCertificateSource is set to USE_SDS.
9411 # The configuration to access the SDS server.
9412 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
9413 # gRPC config to access the SDS server.
9414 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
9415 # gRPC call credentials to access the SDS server.
9416 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
9417 # This field can be set to one of the following:
9418 #
9419 # - GCE_VM: The local GCE VM service account credentials are used to access
9420 # the SDS server.
9421 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
9422 # SDS server.
9423 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
9424 # FROM_PLUGIN.
9425 # Custom authenticator credentials.
9426 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
9427 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
9428 # plugin.
9429 },
9430 },
9431 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
9432 # gRPC channel credentials to access the SDS server.
9433 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
9434 # The paths to the mounted TLS Certificates and private key.
9435 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9436 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9437 },
9438 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
9439 # to one of the following:
9440 # CERTIFICATES: Use TLS certificates to access the SDS server.
9441 # GCE_VM: Use local GCE VM credentials to access the SDS server.
9442 },
9443 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
9444 },
9445 },
9446 },
9447 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
9448 # validate the client/server certificate. If omitted, the proxy will not
9449 # validate the server or client certificate.
9450 # certificate to validate the client/server certificate.
9451 # validate the client/server certificate.
9452 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
9453 # client or server certificate.
9454 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
9455 # is applicable only if tlsCertificateSource is set to USE_SDS.
9456 # The configuration to access the SDS server.
9457 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
9458 # gRPC config to access the SDS server.
9459 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
9460 # gRPC call credentials to access the SDS server.
9461 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
9462 # This field can be set to one of the following:
9463 #
9464 # - GCE_VM: The local GCE VM service account credentials are used to access
9465 # the SDS server.
9466 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
9467 # SDS server.
9468 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
9469 # FROM_PLUGIN.
9470 # Custom authenticator credentials.
9471 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
9472 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
9473 # plugin.
9474 },
9475 },
9476 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
9477 # gRPC channel credentials to access the SDS server.
9478 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
9479 # The paths to the mounted TLS Certificates and private key.
9480 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9481 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9482 },
9483 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
9484 # to one of the following:
9485 # CERTIFICATES: Use TLS certificates to access the SDS server.
9486 # GCE_VM: Use local GCE VM credentials to access the SDS server.
9487 },
9488 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
9489 },
9490 },
9491 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
9492 },
9493 },
9494 },
9495 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
9496 # (RBAC) config.
9497 # Authorization config defines the Role Based Access Control (RBAC) config.
9498 # method-level access control for a service.
9499 # control for a service.
9500 &quot;policies&quot;: [ # List of RbacPolicies.
9501 {
9502 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
9503 &quot;permissions&quot;: [ # The list of permissions.
9504 { # [Deprecated] All fields defined in a permission are ANDed.
9505 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
9506 { # Custom constraint that specifies a key and a list of allowed values for
9507 # Istio attributes.
9508 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
9509 &quot;values&quot;: [ # A list of allowed values.
9510 &quot;A String&quot;,
9511 ],
9512 },
9513 ],
9514 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
9515 # applies to. Exact match, prefix match, and suffix match are supported.
9516 &quot;A String&quot;,
9517 ],
9518 &quot;methods&quot;: [ # HTTP method.
9519 &quot;A String&quot;,
9520 ],
9521 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
9522 &quot;A String&quot;,
9523 ],
9524 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
9525 &quot;A String&quot;,
9526 ],
9527 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
9528 &quot;A String&quot;,
9529 ],
9530 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
9531 &quot;A String&quot;,
9532 ],
9533 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
9534 # Exact match, prefix match, and suffix match are supported.
9535 &quot;A String&quot;,
9536 ],
9537 &quot;ports&quot;: [ # Port names or numbers.
9538 &quot;A String&quot;,
9539 ],
9540 },
9541 ],
9542 &quot;principals&quot;: [ # The list of principals.
9543 { # [Deprecated] All fields defined in a principal are ANDed.
9544 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
9545 &quot;groups&quot;: [ # The groups the principal belongs to.
9546 # Exact match, prefix match, and suffix match are supported.
9547 &quot;A String&quot;,
9548 ],
9549 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
9550 &quot;A String&quot;,
9551 ],
9552 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
9553 &quot;A String&quot;,
9554 ],
9555 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
9556 &quot;A String&quot;,
9557 ],
9558 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
9559 &quot;A String&quot;,
9560 ],
9561 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
9562 &quot;A String&quot;,
9563 ],
9564 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
9565 &quot;A String&quot;,
9566 ],
9567 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
9568 # suffix match are supported for values. For example,
9569 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
9570 &quot;a_key&quot;: &quot;A String&quot;,
9571 },
9572 &quot;users&quot;: [ # The user names/IDs or service accounts.
9573 # Exact match, prefix match, and suffix match are supported.
9574 &quot;A String&quot;,
9575 ],
9576 },
9577 ],
9578 },
9579 ],
9580 },
9581 &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
9582 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
9583 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
9584 # private storage buckets that support Signature Version 4 for authentication.
9585 # The service name for generating the authentication header will always default
9586 # to &#x27;s3&#x27;.
9587 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
9588 # creating a backend that uses AWS v4 signature authentication, but will not
9589 # be returned as part of the configuration when queried with a REST API GET
9590 # request.
9591 #
9592 # @InputOnly
9593 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
9594 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
9595 # keep track of different iterations of your access key.
9596 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
9597 # the name of the region your cloud uses to host your origin. For example,
9598 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
9599 },
9600 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
9601 # that describes how clients should authenticate with this service&#x27;s
9602 # backends.
9603 #
9604 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
9605 # to INTERNAL_SELF_MANAGED.
9606 #
9607 # If left blank, communications are not encrypted.
9608 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
9609 # originating from the backend service.
9610 # the backend service.
9611 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
9612 # identity information. This field is only applicable when mode is set to
9613 # MUTUAL.
9614 # The TLS settings for the client or server.
9615 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
9616 # certificate.
9617 # Defines the mechanism to obtain the client or server certificate.
9618 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
9619 # applicable only if tlsCertificateSource is set to USE_PATH.
9620 # The paths to the mounted TLS Certificates and private key.
9621 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9622 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9623 },
9624 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
9625 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
9626 # is applicable only if tlsCertificateSource is set to USE_SDS.
9627 # The configuration to access the SDS server.
9628 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
9629 # gRPC config to access the SDS server.
9630 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
9631 # gRPC call credentials to access the SDS server.
9632 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
9633 # This field can be set to one of the following:
9634 #
9635 # - GCE_VM: The local GCE VM service account credentials are used to access
9636 # the SDS server.
9637 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
9638 # SDS server.
9639 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
9640 # FROM_PLUGIN.
9641 # Custom authenticator credentials.
9642 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
9643 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
9644 # plugin.
9645 },
9646 },
9647 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
9648 # gRPC channel credentials to access the SDS server.
9649 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
9650 # The paths to the mounted TLS Certificates and private key.
9651 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9652 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9653 },
9654 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
9655 # to one of the following:
9656 # CERTIFICATES: Use TLS certificates to access the SDS server.
9657 # GCE_VM: Use local GCE VM credentials to access the SDS server.
9658 },
9659 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
9660 },
9661 },
9662 },
9663 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
9664 # validate the client/server certificate. If omitted, the proxy will not
9665 # validate the server or client certificate.
9666 # certificate to validate the client/server certificate.
9667 # validate the client/server certificate.
9668 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
9669 # client or server certificate.
9670 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
9671 # is applicable only if tlsCertificateSource is set to USE_SDS.
9672 # The configuration to access the SDS server.
9673 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
9674 # gRPC config to access the SDS server.
9675 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
9676 # gRPC call credentials to access the SDS server.
9677 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
9678 # This field can be set to one of the following:
9679 #
9680 # - GCE_VM: The local GCE VM service account credentials are used to access
9681 # the SDS server.
9682 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
9683 # SDS server.
9684 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
9685 # FROM_PLUGIN.
9686 # Custom authenticator credentials.
9687 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
9688 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
9689 # plugin.
9690 },
9691 },
9692 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
9693 # gRPC channel credentials to access the SDS server.
9694 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
9695 # The paths to the mounted TLS Certificates and private key.
9696 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
9697 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
9698 },
9699 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
9700 # to one of the following:
9701 # CERTIFICATES: Use TLS certificates to access the SDS server.
9702 # GCE_VM: Use local GCE VM credentials to access the SDS server.
9703 },
9704 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
9705 },
9706 },
9707 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
9708 },
9709 },
9710 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
9711 # The value of this field determines how TLS is enforced. This can be set
9712 # to one of the following values: DISABLE: Do not setup a TLS connection to
9713 # the backends.
9714 # SIMPLE: Originate a TLS connection to the backends.
9715 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
9716 # client certificates for authentication.
9717 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
9718 # applicable only when mode is SIMPLE or MUTUAL.
9719 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
9720 # certificate.If specified,
9721 # the proxy will verify that the server certificate&#x27;s subject alt name
9722 # matches one of the specified values. This field is applicable only when
9723 # mode is SIMPLE or MUTUAL.
9724 &quot;A String&quot;,
9725 ],
9726 },
9727 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
9728 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
9729 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
9730 # specified values, the communication continues. Otherwise, it fails. This
9731 # additional check enables the client to verify that the server is authorized
9732 # to run the requested service.
9733 #
9734 # Note that the contents of the server
9735 # certificate&#x27;s subjectAltName field are configured by the
9736 # Public Key Infrastructure which provisions server identities.
9737 #
9738 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
9739 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
9740 # mode).
9741 &quot;A String&quot;,
9742 ],
9743 },
9744 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9745 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
9746 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
9747 #
9748 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
9749 # If set, lists of backends and health checks must be both empty.
9750 &quot;A String&quot;,
9751 ],
9752 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
9753 #
9754 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
9755 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
9756 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
9757 #
9758 # Only NONE and HEADER_FIELD are supported
9759 # when the backend service is referenced by a URL map that is bound to
9760 # target gRPC proxy that has validateForProxyless field set to true.
9761 #
9762 # For more details, see:
9763 # [Session
9764 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
9765 #
9766 # sessionAffinity cannot be specified with haPolicy.
9767 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
9768 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
9769 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
9770 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
9771 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
9772 # as a count of seconds and fractions of seconds at nanosecond
9773 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9774 # or &quot;month&quot;. Range is approximately 10,000 years.
9775 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9776 # Durations less than one second are represented with a 0
9777 # `seconds` field and a positive `nanos` field. Must be from 0
9778 # to 999,999,999 inclusive.
9779 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9780 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9781 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9782 },
9783 },
9784 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
9785 # Currently this is applicable only for Internal TCP/UDP load balancing,
9786 # Internal HTTP(S) load balancing and Traffic Director.
9787 &quot;policy&quot;: &quot;A String&quot;,
9788 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
9789 # each service mesh client.
9790 #
9791 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
9792 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
9793 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
9794 # `INTERNAL_SELF_MANAGED`.
9795 #
9796 # `subset_size` is optional for Internal HTTP(S) load balancing
9797 # and required for Traffic Director.
9798 #
9799 # If you do not provide this value, Cloud Load Balancing will calculate it
9800 # dynamically to optimize the number of proxies/clients visible to each
9801 # backend and vice versa.
9802 #
9803 # Must be greater than 0. If `subset_size` is larger than the number of
9804 # backends/endpoints, then subsetting is disabled.
9805 },
9806 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
9807 # type of load balancer. For more information see,
9808 # Backend service settings.
9809 # The default is 30 seconds.
9810 # The full range of timeout values allowed goes from 1
9811 # through 2,147,483,647 seconds.
9812 #
9813 # This value can be overridden in the PathMatcher configuration of the
9814 # UrlMap that references this backend service.
9815 #
9816 # Not supported when the backend service is referenced by a URL map that is
9817 # bound to target gRPC proxy that has validateForProxyless field set to true.
9818 # Instead, use maxStreamDuration.
9819 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
9820 # when the backend protocol is SSL, HTTPS or HTTP2.
9821 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
9822 # networksecurity.googleapis.com namespace. Can be used in authenticating
9823 # TLS connections to the backend, as specified by the authenticationMode
9824 # field. Can only be specified if authenticationMode is not NONE.
9825 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
9826 #
9827 #
9828 # Use this property to configure the load balancer back-end to use
9829 # certificates and roots of trust provisioned by the Managed Workload
9830 # Identity system.
9831 #
9832 # The `identity` property is the
9833 # fully-specified SPIFFE ID to use in the SVID presented by the Load
9834 # Balancer Workload.
9835 #
9836 # The SPIFFE ID must be a resource starting with the
9837 # `trustDomain` property value, followed by the path to the Managed
9838 # Workload Identity.
9839 #
9840 # Supported SPIFFE ID format:
9841 #
9842 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
9843 #
9844 #
9845 # The Trust Domain within the Managed Identity must refer to a valid
9846 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
9847 # will be inherited from the Workload Identity Pool.
9848 #
9849 # Restrictions:
9850 #
9851 # - If you set the `identity` property, you cannot manually set
9852 # the following fields:
9853 # - tlsSettings.sni
9854 # - tlsSettings.subjectAltNames
9855 # - tlsSettings.authenticationConfig
9856 #
9857 #
9858 # When defining a `identity` for a RegionBackendServices, the
9859 # corresponding Workload Identity Pool must have a ca_pool
9860 # configured in the same region.
9861 #
9862 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
9863 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
9864 # balancer sends this string as the SNI hostname in the TLS connection to
9865 # the backend, and requires that this string match a Subject Alternative
9866 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
9867 # NEG backend, if the SNI is specified here, the load balancer uses it
9868 # regardless of whether the Regional Internet NEG is specified with FQDN or
9869 # IP address and port. When both sni and subjectAltNames[] are specified,
9870 # the load balancer matches the backend certificate&#x27;s SAN only to
9871 # subjectAltNames[].
9872 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
9873 # verifies during a TLS handshake with the backend. When the server
9874 # presents its X.509 certificate to the Load Balancer, the Load Balancer
9875 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
9876 # match one of the subjectAltNames in the list. This field is limited to 5
9877 # entries. When both sni and subjectAltNames[] are specified, the load
9878 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
9879 { # A Subject Alternative Name that the load balancer matches against the SAN
9880 # field in the TLS certificate provided by the backend, specified as either
9881 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
9882 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
9883 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
9884 },
9885 ],
9886 },
9887 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
9888 {
9889 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
9890 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
9891 # and ForwardingRule.
9892 },
9893 ],
9894 },
9895 ],
9896 &quot;kind&quot;: &quot;compute#backendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.
9897 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
9898 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
9899 # the query parameter pageToken in the next list request.
9900 # Subsequent list requests will have their own nextPageToken to
9901 # continue paging through the results.
9902 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
9903 &quot;warning&quot;: { # [Output Only] Informational warning message.
9904 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9905 # Engine returns NO_RESULTS_ON_PAGE if there
9906 # are no results in the response.
9907 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9908 # value format. For example:
9909 #
9910 # &quot;data&quot;: [
9911 # {
9912 # &quot;key&quot;: &quot;scope&quot;,
9913 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9914 # }
9915 {
9916 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9917 # returned. For example, for warnings where there are no results in a list
9918 # request for a particular zone, this key might be scope and
9919 # the key value might be the zone name. Other examples might be a key
9920 # indicating a deprecated resource and a suggested replacement, or a
9921 # warning about invalid network settings (for example, if an instance
9922 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9923 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9924 },
9925 ],
9926 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9927 },
9928 }</pre>
9929 </div>
9930
9931 <div class="method">
9932 <code class="details" id="listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
9933 <pre>Retrieves a list of all usable backend services in the specified project.
9934
9935 Args:
9936 project: string, Project ID for this request. (required)
9937 filter: string, A filter expression that filters resources listed in the response. Most
9938 Compute resources support two types of filter expressions:
9939 expressions that support regular expressions and expressions that follow
9940 API improvement proposal AIP-160.
9941 These two types of filter expressions cannot be mixed in one request.
9942
9943 If you want to use AIP-160, your expression must specify the field name, an
9944 operator, and the value that you want to use for filtering. The value
9945 must be a string, a number, or a boolean. The operator
9946 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
9947
9948 For example, if you are filtering Compute Engine instances, you can
9949 exclude instances named `example-instance` by specifying
9950 `name != example-instance`.
9951
9952 The `:*` comparison can be used to test whether a key has been defined.
9953 For example, to find all objects with `owner` label use:
9954 ```
9955 labels.owner:*
9956 ```
9957
9958 You can also filter nested fields. For example, you could specify
9959 `scheduling.automaticRestart = false` to include instances only
9960 if they are not scheduled for automatic restarts. You can use filtering
9961 on nested fields to filter based onresource labels.
9962
9963 To filter on multiple expressions, provide each separate expression within
9964 parentheses. For example:
9965 ```
9966 (scheduling.automaticRestart = true)
9967 (cpuPlatform = &quot;Intel Skylake&quot;)
9968 ```
9969 By default, each expression is an `AND` expression. However, you
9970 can include `AND` and `OR` expressions explicitly.
9971 For example:
9972 ```
9973 (cpuPlatform = &quot;Intel Skylake&quot;) OR
9974 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
9975 (scheduling.automaticRestart = true)
9976 ```
9977
9978 If you want to use a regular expression, use the `eq` (equal) or `ne`
9979 (not equal) operator against a single un-parenthesized expression with or
9980 without quotes or against multiple parenthesized expressions. Examples:
9981
9982 `fieldname eq unquoted literal`
9983 `fieldname eq &#x27;single quoted literal&#x27;`
9984 `fieldname eq &quot;double quoted literal&quot;`
9985 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
9986
9987 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
9988 The literal value must match the entire field.
9989
9990 For example, to filter for instances that do not end with name &quot;instance&quot;,
9991 you would use `name ne .*instance`.
9992
9993 You cannot combine constraints on multiple fields using regular
9994 expressions.
9995 maxResults: integer, The maximum number of results per page that should be returned.
9996 If the number of available results is larger than `maxResults`,
9997 Compute Engine returns a `nextPageToken` that can be used to get
9998 the next page of results in subsequent list requests. Acceptable values are
9999 `0` to `500`, inclusive. (Default: `500`)
10000 orderBy: string, Sorts list results by a certain order. By default, results
10001 are returned in alphanumerical order based on the resource name.
10002
10003 You can also sort results in descending order based on the creation
10004 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
10005 results based on the `creationTimestamp` field in
10006 reverse chronological order (newest result first). Use this to sort
10007 resources like operations so that the newest operation is returned first.
10008
10009 Currently, only sorting by `name` or
10010 `creationTimestamp desc` is supported.
10011 pageToken: string, Specifies a page token to use. Set `pageToken` to the
10012 `nextPageToken` returned by a previous list request to get
10013 the next page of results.
10014 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
10015 of failure. The default value is false.
10016
10017 For example, when partial success behavior is enabled, aggregatedList for a
10018 single zone scope either returns all resources in the zone or no resources,
10019 with an error code.
10020 x__xgafv: string, V1 error format.
10021 Allowed values
10022 1 - v1 error format
10023 2 - v2 error format
10024
10025 Returns:
10026 An object of the form:
10027
10028 { # Contains a list of usable BackendService resources.
10029 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
10030 &quot;items&quot;: [ # A list of BackendService resources.
10031 { # Represents a Backend Service resource.
10032 #
10033 # A backend service defines how Google Cloud load balancers distribute traffic.
10034 # The backend service configuration contains a set of values, such as the
10035 # protocol used to connect to backends, various distribution and session
10036 # settings, health checks, and timeouts. These settings provide fine-grained
10037 # control over how your load balancer behaves. Most of the settings have
10038 # default values that allow for easy configuration if you need to get started
10039 # quickly.
10040 #
10041 # Backend services in Google Compute Engine can be either regionally or
10042 # globally scoped.
10043 #
10044 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
10045 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
10046 #
10047 # For more information, seeBackend
10048 # Services.
10049 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
10050 # Load Balancers and Traffic Director and requires
10051 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
10052 #
10053 # If set to 0, the cookie is non-persistent and lasts only until
10054 # the end of the browser session (or equivalent). The maximum allowed value
10055 # is two weeks (1,209,600).
10056 #
10057 # Not supported when the backend service is referenced by a URL map that is
10058 # bound to target gRPC proxy that has validateForProxyless field set to true.
10059 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
10060 # load balancing scheme set to INTERNAL_SELF_MANAGED.
10061 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
10062 { # Message containing information of one individual backend.
10063 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
10064 # handle additional traffic or is fully loaded. For usage guidelines, see
10065 # Connection balancing mode.
10066 #
10067 # Backends must use compatible balancing modes. For more information, see
10068 # Supported balancing modes and target capacity settings and
10069 # Restrictions and guidance for instance groups.
10070 #
10071 # Note: Currently, if you use the API to configure incompatible balancing
10072 # modes, the configuration might be accepted even though it has no impact
10073 # and is ignored. Specifically, Backend.maxUtilization is ignored when
10074 # Backend.balancingMode is RATE. In the future, this incompatible combination
10075 # will be rejected.
10076 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
10077 # mode.
10078 # The default value is 1, which means the group serves up to
10079 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
10080 # completely drained, offering 0% of its available capacity. The valid ranges
10081 # are 0.0 and [0.1,1.0].
10082 # You cannot configure a setting larger than 0 and smaller than0.1.
10083 # You cannot configure a setting of 0 when there is only one
10084 # backend attached to the backend service.
10085 #
10086 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
10087 # internet NEGs, regional serverless NEGs, and PSC NEGs.
10088 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
10089 # BalancingMode.
10090 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
10091 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
10092 # Monitoring, but is not used for load balancing.
10093 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
10094 # balancing mode. The valid range is [0.0, 1.0].
10095 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
10096 # long and match the regular expression
10097 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
10098 # first character must be a lowercase letter, and all following
10099 # characters must be a dash, period, underscore, lowercase letter, or
10100 # digit, except the last character, which cannot be a dash, period, or
10101 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
10102 # field can only be used for a global or regional backend service with the
10103 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
10104 },
10105 ],
10106 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
10107 # create the resource.
10108 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
10109 # failover backend can be configured for a given BackendService.
10110 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
10111 # group or network endpoint
10112 # group (NEG) resource. To determine what types of backends a load
10113 # balancer supports, see the [Backend services
10114 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
10115 #
10116 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
10117 # or NEG. Partial URLs are not supported.
10118 #
10119 # If haPolicy is specified, backends must refer to NEG resources of type
10120 # GCE_VM_IP.
10121 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
10122 # guidelines, seeConnection
10123 # balancing mode and Utilization
10124 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
10125 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
10126 # guidelines, seeConnection
10127 # balancing mode and Utilization
10128 # balancing mode.
10129 #
10130 # Not available if the backend&#x27;s balancingMode isRATE.
10131 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
10132 # For usage guidelines, seeConnection
10133 # balancing mode and Utilization
10134 # balancing mode.
10135 #
10136 # Not available if the backend&#x27;s balancingMode isRATE.
10137 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
10138 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
10139 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
10140 # Not available if backend&#x27;s balancingMode is RATE
10141 # or CONNECTION.
10142 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
10143 # Not available if backend&#x27;s balancingMode is RATE
10144 # or CONNECTION.
10145 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
10146 # usage guidelines, seeRate
10147 # balancing mode and Utilization
10148 # balancing mode.
10149 #
10150 # Not available if the backend&#x27;s balancingMode isCONNECTION.
10151 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
10152 # guidelines, seeRate
10153 # balancing mode and Utilization
10154 # balancing mode.
10155 #
10156 # Not available if the backend&#x27;s balancingMode isCONNECTION.
10157 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
10158 # guidelines, seeRate
10159 # balancing mode and Utilization
10160 # balancing mode.
10161 #
10162 # Not available if the backend&#x27;s balancingMode isCONNECTION.
10163 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
10164 #
10165 # For usage guidelines, seeUtilization
10166 # balancing mode.
10167 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
10168 # the backend.
10169 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
10170 },
10171 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
10172 # sending traffic to backends with default preference. The possible values
10173 # are:
10174 #
10175 # - PREFERRED: Backends with this preference level will be
10176 # filled up to their capacity limits first, based on RTT.
10177 # - DEFAULT: If preferred backends don&#x27;t have enough
10178 # capacity, backends in this layer would be used and traffic would be
10179 # assigned based on the load balancing algorithm you use. This is the
10180 # default
10181 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
10182 # Attachment).
10183 # e.g.
10184 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
10185 # for Cloud Run service.
10186 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
10187 # for PSC Service Attachment.
10188 &quot;trafficDuration&quot;: &quot;A String&quot;,
10189 },
10190 ],
10191 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
10192 # specified load balancer types.
10193 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
10194 # Pragma or Authorization headers. Up to 5 headers can be specified.
10195 # The cache is bypassed for all cdnPolicy.cacheMode settings.
10196 { # Bypass the cache when the specified request headers are present,
10197 # e.g. Pragma or Authorization headers. Values are case insensitive.
10198 # The presence of such a header overrides the cache_mode setting.
10199 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
10200 # Values are case-insensitive.
10201 },
10202 ],
10203 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
10204 # CDN.
10205 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
10206 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
10207 &quot;A String&quot;,
10208 ],
10209 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
10210 # The name=value pair will be used in the cache key Cloud CDN generates.
10211 &quot;A String&quot;,
10212 ],
10213 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
10214 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
10215 # query_string_whitelist and query_string_blacklist. If neither is set, the
10216 # entire query string will be included. If false, the query string will be
10217 # excluded from the cache key entirely.
10218 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
10219 # parameters will be included. Either specify query_string_whitelist or
10220 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
10221 # not treated as delimiters.
10222 &quot;A String&quot;,
10223 ],
10224 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
10225 # parameters will be excluded. Either specify query_string_whitelist or
10226 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
10227 # not treated as delimiters.
10228 &quot;A String&quot;,
10229 ],
10230 },
10231 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
10232 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
10233 # headers to cache content. Responses without these headers will not be
10234 # cached at Google&#x27;s edge, and will require a full trip to the origin on
10235 # every request, potentially impacting performance and increasing load on
10236 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
10237 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
10238 # Warning: this may result in Cloud CDN caching private,
10239 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
10240 # including common image formats, media (video and audio), and web assets
10241 # (JavaScript and CSS). Requests and responses that are marked as
10242 # uncacheable, as well as dynamic content (including HTML), will not be
10243 # cached.
10244 #
10245 # If no value is provided for cdnPolicy.cacheMode, it defaults
10246 # to CACHE_ALL_STATIC.
10247 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
10248 # used to clamp the max-age (or Expires) value sent to the client. With
10249 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
10250 # response max-age directive, along with a &quot;public&quot; directive. For
10251 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
10252 # from the origin (if specified), or else sets the response max-age
10253 # directive to the lesser of the client_ttl and default_ttl, and also
10254 # ensures a &quot;public&quot; cache-control directive is present.
10255 # If a client TTL is not specified, a default value (1 hour) will be used.
10256 # The maximum allowed value is 31,622,400s (1 year).
10257 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
10258 # responses that do not have an existing valid TTL (max-age or s-maxage).
10259 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
10260 # The value of defaultTTL cannot be set to a value greater than that of
10261 # maxTTL, but can be equal.
10262 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
10263 # will overwrite the TTL set in all responses. The maximum allowed value is
10264 # 31,622,400s (1 year), noting that infrequently accessed objects may be
10265 # evicted from the cache before the defined TTL.
10266 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
10267 # origin.
10268 # Cache directives that attempt to set a max-age or s-maxage higher than
10269 # this, or an Expires header more than maxTTL seconds in the future will
10270 # be capped at the value of maxTTL, as if it were the value of an
10271 # s-maxage Cache-Control directive.
10272 # Headers sent to the client will not be modified.
10273 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
10274 # The maximum allowed value is 31,622,400s (1 year), noting that
10275 # infrequently accessed objects may be evicted from the cache before
10276 # the defined TTL.
10277 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
10278 # to apply fine-grained caching for common errors or redirects.
10279 # This can reduce the load on your origin and improve end-user
10280 # experience by reducing response latency.
10281 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
10282 # negative caching applies to responses with the specified response code
10283 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
10284 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
10285 # to all responses with the specified response code, and override any
10286 # caching headers.
10287 # By default, Cloud CDN will apply the following default TTLs to these
10288 # status codes:
10289 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
10290 # HTTP 404 (Not Found), 410 (Gone),
10291 # 451 (Unavailable For Legal Reasons): 120s
10292 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
10293 # These defaults can be overridden in negative_caching_policy.
10294 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
10295 # negative_caching must be enabled to configure negative_caching_policy.
10296 # Omitting the policy and leaving negative_caching enabled will use
10297 # Cloud CDN&#x27;s default cache TTLs.
10298 # Note that when specifying an explicit negative_caching_policy, you
10299 # should take care to specify a cache TTL for all response codes
10300 # that you wish to cache. Cloud CDN will not apply any default
10301 # negative caching when a policy exists.
10302 { # Specify CDN TTLs for response error codes.
10303 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
10304 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
10305 # specified as values, and you cannot specify a status code more than
10306 # once.
10307 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
10308 # corresponding status code.
10309 # The maximum allowed value is 1800s (30 minutes), noting that
10310 # infrequently accessed objects may be evicted from the cache before the
10311 # defined TTL.
10312 },
10313 ],
10314 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
10315 # requests into a small number of requests to the origin.
10316 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
10317 # content with the origin, or when an error is encountered when refreshing
10318 # the cache.
10319 # This setting defines the default &quot;max-stale&quot; duration for any cached
10320 # responses that do not specify a max-stale directive. Stale responses that
10321 # exceed the TTL configured here will not be served. The default limit
10322 # (max-stale) is 86400s (1 day), which will allow stale content to be
10323 # served up to this limit beyond the max-age (or s-maxage) of a cached
10324 # response.
10325 # The maximum allowed value is 604800 (1 week).
10326 # Set this to zero (0) to disable serve-while-stale.
10327 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
10328 # considered fresh. After this time period, the response will be
10329 # revalidated before being served. Defaults to 1hr (3600s). When serving
10330 # responses to signed URL requests, Cloud CDN will internally behave as
10331 # though all responses from this backend had a &quot;Cache-Control:
10332 # public, max-age=[TTL]&quot; header, regardless of any existing
10333 # Cache-Control header. The actual headers served in responses will not be
10334 # altered.
10335 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
10336 &quot;A String&quot;,
10337 ],
10338 },
10339 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
10340 # backend service.
10341 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
10342 # as a count of seconds and fractions of seconds at nanosecond
10343 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10344 # or &quot;month&quot;. Range is approximately 10,000 years.
10345 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10346 # Durations less than one second are represented with a 0
10347 # `seconds` field and a positive `nanos` field. Must be from 0
10348 # to 999,999,999 inclusive.
10349 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10350 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10351 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10352 },
10353 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
10354 # there is no limit.
10355 #
10356 # Not supported when the backend service is referenced by a URL map that is
10357 # bound to target gRPC proxy that has validateForProxyless field set to true.
10358 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
10359 # not specified, there is no limit.
10360 #
10361 # Not supported when the backend service is referenced by a URL map that is
10362 # bound to target gRPC proxy that has validateForProxyless field set to true.
10363 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
10364 # service. If not specified, there is no limit.
10365 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
10366 # This parameter is respected by both the HTTP/1.1 and HTTP/2
10367 # implementations. If not specified, there is no limit. Setting this
10368 # parameter to 1 will effectively disable keep alive.
10369 #
10370 # Not supported when the backend service is referenced by a URL map that is
10371 # bound to target gRPC proxy that has validateForProxyless field set to true.
10372 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
10373 # not specified, the default is 1.
10374 #
10375 # Not supported when the backend service is referenced by a URL map that is
10376 # bound to target gRPC proxy that has validateForProxyless field set to true.
10377 },
10378 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
10379 # the client&#x27;s Accept-Encoding header.
10380 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
10381 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
10382 # instance. For supported load balancers and protocols, as described inEnabling
10383 # connection draining.
10384 },
10385 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
10386 # tracking policy settings are only available for external passthrough
10387 # Network Load Balancers and internal passthrough Network Load Balancers.
10388 #
10389 # connectionTrackingPolicy cannot be specified with haPolicy.
10390 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
10391 # value is DEFAULT_FOR_PROTOCOL.
10392 #
10393 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
10394 # persist on unhealthy backends only for connection-oriented protocols
10395 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
10396 # Affinity is configured for 5-tuple. They do not persist forUDP.
10397 #
10398 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
10399 # the existing connections on the unhealthy backend are never persisted on
10400 # the unhealthy backend. They are always diverted to newly selected healthy
10401 # backends (unless all backends are unhealthy).
10402 #
10403 # If set to ALWAYS_PERSIST, existing connections always
10404 # persist on unhealthy backends regardless of protocol and session
10405 # affinity. It is generally not recommended to use this mode overriding the
10406 # default.
10407 #
10408 # For more details, see [Connection Persistence for Network Load
10409 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
10410 # and [Connection Persistence for Internal TCP/UDP Load
10411 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
10412 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
10413 # Balancers. This option is not available publicly.
10414 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
10415 # matching traffic (in seconds).
10416 #
10417 # For internal passthrough Network Load Balancers:
10418 #
10419 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
10420 # - It can be set only if Connection Tracking is less than 5-tuple
10421 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
10422 # Mode is PER_SESSION).
10423 #
10424 #
10425 #
10426 # For external passthrough Network Load Balancers the default is 60
10427 # seconds. This option is not available publicly.
10428 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
10429 # options:
10430 #
10431 # - PER_CONNECTION: This is the default mode. The Connection
10432 # Tracking is performed as per the Connection Key (default Hash Method) for
10433 # the specific protocol.
10434 # - PER_SESSION: The Connection Tracking is performed as per
10435 # the configured Session Affinity. It matches the configured Session
10436 # Affinity.
10437 #
10438 #
10439 #
10440 # For more details, see [Tracking Mode for Network Load
10441 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
10442 # and [Tracking Mode for Internal TCP/UDP Load
10443 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
10444 },
10445 &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
10446 # affinity based on HTTP headers, cookies or other properties. This load
10447 # balancing policy is applicable only for HTTP connections. The affinity to a
10448 # particular destination host will be lost when one or more hosts are
10449 # added/removed from the destination service. This field specifies parameters
10450 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
10451 #
10452 # This field is applicable to either:
10453 #
10454 # - A regional backend service with the service protocol set to HTTP,
10455 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10456 # INTERNAL_MANAGED.
10457 # - A global backend service with the
10458 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
10459 &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
10460 # be used as the hash key for the consistent hash load balancer. If the
10461 # cookie is not present, it will be generated. This field is applicable if
10462 # the sessionAffinity is set to HTTP_COOKIE.
10463 #
10464 # Not supported when the backend service is referenced by a URL map that is
10465 # bound to target gRPC proxy that has validateForProxyless field set to true.
10466 # for load balancing policies that use a consistent hash.
10467 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
10468 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
10469 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
10470 # as a count of seconds and fractions of seconds at nanosecond
10471 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10472 # or &quot;month&quot;. Range is approximately 10,000 years.
10473 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10474 # Durations less than one second are represented with a 0
10475 # `seconds` field and a positive `nanos` field. Must be from 0
10476 # to 999,999,999 inclusive.
10477 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10478 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10479 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10480 },
10481 },
10482 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
10483 # applicable if the sessionAffinity is set toHEADER_FIELD.
10484 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
10485 # 1024. Larger ring sizes result in more granular load distributions. If the
10486 # number of hosts in the load balancing pool is larger than the ring size,
10487 # each host will be assigned a single virtual node.
10488 },
10489 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
10490 # text format.
10491 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
10492 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
10493 # locality_lb_policy.
10494 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
10495 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
10496 # long and match the regular expression
10497 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
10498 # first character must be a lowercase letter, and all following
10499 # characters must be a dash, period, underscore, lowercase letter, or
10500 # digit, except the last character, which cannot be a dash, period, or
10501 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
10502 # field can only be used for a global or regional backend service with the
10503 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
10504 },
10505 ],
10506 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
10507 # custom
10508 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
10509 &quot;A String&quot;,
10510 ],
10511 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
10512 # custom
10513 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
10514 &quot;A String&quot;,
10515 ],
10516 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
10517 # create the resource.
10518 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
10519 # backend service with dynamic forwarding feature which together with Service
10520 # Extension allows customized and complex routing logic.
10521 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
10522 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
10523 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
10524 },
10525 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
10526 # service. Some ranges are restricted: Restricted
10527 # ranges.
10528 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
10529 },
10530 },
10531 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
10532 # this backend service.
10533 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
10534 # global external Application Load Balancer.
10535 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
10536 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
10537 #
10538 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
10539 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
10540 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
10541 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
10542 # externalManagedMigrationTestingPercentage.
10543 #
10544 # Rolling back a migration requires the states to be set in reverse order. So
10545 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
10546 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
10547 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
10548 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
10549 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
10550 # external Application Load Balancer.
10551 #
10552 # The value of this field must be in the range [0, 100].
10553 #
10554 # Session affinity options will slightly affect this routing behavior, for
10555 # more details, see:Session
10556 # Affinity.
10557 #
10558 # This value can only be set if the loadBalancingScheme in the BackendService
10559 # is set to EXTERNAL (when using the classic Application Load Balancer) and
10560 # the migration state is TEST_BY_PERCENTAGE.
10561 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
10562 # as a backup (failover) backend.
10563 # For load balancers that have configurable failover:
10564 # [Internal passthrough Network Load
10565 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10566 # and [external passthrough Network Load
10567 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10568 #
10569 # failoverPolicy cannot be specified with haPolicy.
10570 # failover:
10571 # [Internal passthrough Network Load
10572 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10573 # and [external passthrough
10574 # Network Load
10575 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10576 # On failover or failback, this field indicates whether connection draining
10577 # will be honored. Google Cloud has a fixed connection draining timeout of
10578 # 10 minutes. A setting of true terminates existing TCP
10579 # connections to the active pool during failover and failback, immediately
10580 # draining traffic. A setting of false allows existing TCP
10581 # connections to persist, even on VMs no longer in the active pool, for up
10582 # to the duration of the connection draining timeout (10 minutes).
10583 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
10584 #
10585 # The default is false.
10586 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
10587 # load balancer are dropped when all primary and all backup backend VMs are
10588 # unhealthy.If set to false, connections are distributed
10589 # among all primary VMs when all primary and all backup backend VMs are
10590 # unhealthy.
10591 # For load balancers that have configurable
10592 # failover:
10593 # [Internal passthrough
10594 # Network Load
10595 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10596 # and [external passthrough
10597 # Network Load
10598 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10599 # The default is false.
10600 &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
10601 # failover when the number of healthy primary VMs equals zero.
10602 # For all other values, the load balancer performs a failover when the
10603 # total number of healthy primary VMs is less than this ratio.
10604 # For load balancers that have configurable
10605 # failover:
10606 # [Internal TCP/UDP Load
10607 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10608 # and [external TCP/UDP Load
10609 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10610 },
10611 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
10612 # This field is used in optimistic locking. This field will be ignored when
10613 # inserting a BackendService. An up-to-date fingerprint must be provided in
10614 # order to update the BackendService, otherwise the request will
10615 # fail with error 412 conditionNotMet.
10616 #
10617 # To see the latest fingerprint, make a get() request to
10618 # retrieve a BackendService.
10619 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
10620 # Protocol Forwarding.
10621 #
10622 # The backends of this regional backend service must only specify zonal
10623 # network endpoint groups (NEGs) of type GCE_VM_IP.
10624 #
10625 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
10626 # regional backend service must set the network field. All zonal NEGs must
10627 # belong to the same network. However, individual NEGs can
10628 # belong to different subnetworks of that network.
10629 #
10630 # When haPolicy is specified, the set of attached network endpoints across
10631 # all backends comprise an High Availability domain from which one endpoint
10632 # is selected as the active endpoint (the leader) that receives all
10633 # traffic.
10634 #
10635 # haPolicy can be added only at backend service creation time. Once set up,
10636 # it cannot be deleted.
10637 #
10638 # Note that haPolicy is not for load balancing, and therefore cannot be
10639 # specified with sessionAffinity, connectionTrackingPolicy, and
10640 # failoverPolicy.
10641 #
10642 # haPolicy requires customers to be responsible for tracking backend
10643 # endpoint health and electing a leader among the healthy endpoints.
10644 # Therefore, haPolicy cannot be specified with healthChecks.
10645 #
10646 # haPolicy can only be specified for External Passthrough Network Load
10647 # Balancers and Internal Passthrough Network Load Balancers.
10648 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
10649 # achieve it.
10650 #
10651 # Supported values are:
10652 #
10653 # - DISABLED: Fast IP Move is disabled. You can only use the
10654 # haPolicy.leader API to update the leader.
10655 # - &gt;GARP_RA: Provides a method to very quickly define a new network
10656 # endpoint as the leader. This method is faster than updating the leader
10657 # using the haPolicy.leader API. Fast IP move works as follows: The VM
10658 # hosting the network endpoint that should become the new leader sends
10659 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
10660 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
10661 # temporarily associates the forwarding rule IP address with that VM, and
10662 # both new and in-flight packets are quickly delivered to that VM.
10663 #
10664 #
10665 #
10666 # Note the important properties of the Fast IP Move functionality:
10667 #
10668 # - The GARP/RA-initiated re-routing stays active for approximately 20
10669 # minutes. After triggering fast failover, you must also
10670 # appropriately set the haPolicy.leader.
10671 # - The new leader instance should continue to send GARP/RA packets
10672 # periodically every 10 seconds until at least 10 minutes after updating
10673 # the haPolicy.leader (but stop immediately if it is no longer the leader).
10674 # - After triggering a fast failover, we recommend that you wait at least
10675 # 3 seconds before sending another GARP/RA packet from a different VM
10676 # instance to avoid race conditions.
10677 # - Don&#x27;t send GARP/RA packets from different VM
10678 # instances at the same time. If multiple instances continue to send
10679 # GARP/RA packets, traffic might be routed to different destinations in an
10680 # alternating order. This condition ceases when a single instance
10681 # issues a GARP/RA packet.
10682 # - The GARP/RA request always takes priority over the leader API.
10683 # Using the haPolicy.leader API to change the leader to a different
10684 # instance will have no effect until the GARP/RA request becomes
10685 # inactive.
10686 # - The GARP/RA packets should follow the GARP/RA
10687 # Packet Specifications..
10688 # - When multiple forwarding rules refer to a regional backend service,
10689 # you need only send a GARP or RA packet for a single forwarding rule
10690 # virtual IP. The virtual IPs for all forwarding rules targeting the same
10691 # backend service will also be moved to the sender of the GARP or RA
10692 # packet.
10693 #
10694 #
10695 #
10696 # The following are the Fast IP Move limitations (that is, when fastIPMove
10697 # is not DISABLED):
10698 #
10699 # - Multiple forwarding rules cannot use the same IP address if one of
10700 # them refers to a regional backend service with fastIPMove.
10701 # - The regional backend service must set the network field, and all
10702 # NEGs must belong to that network. However, individual
10703 # NEGs can belong to different subnetworks of that network.
10704 # - The maximum number of network endpoints across all backends of a
10705 # backend service with fastIPMove is 32.
10706 # - The maximum number of backend services with fastIPMove that can have
10707 # the same network endpoint attached to one of its backends is 64.
10708 # - The maximum number of backend services with fastIPMove in a VPC in a
10709 # region is 64.
10710 # - The network endpoints that are attached to a backend of a backend
10711 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
10712 # - Traffic directed to the leader by a static route next hop will not be
10713 # redirected to a new leader by fast failover. Such traffic will only be
10714 # redirected once an haPolicy.leader update has taken effect. Only traffic
10715 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
10716 # fast failover.
10717 #
10718 #
10719 # haPolicy.fastIPMove can be set only at backend service creation time.
10720 # Once set, it cannot be updated.
10721 #
10722 # By default, fastIpMove is set to DISABLED.
10723 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
10724 # this service as the active endpoint (the leader) that receives all
10725 # traffic.
10726 #
10727 # When the leader changes, there is no connection draining to persist
10728 # existing connections on the old leader.
10729 #
10730 # You are responsible for selecting a suitable endpoint as the
10731 # leader. For example, preferring a healthy endpoint over unhealthy ones.
10732 # Note that this service does not track backend endpoint health, and
10733 # selects the configured leader unconditionally.
10734 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
10735 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
10736 # that the leader is attached to.
10737 #
10738 # The leader&#x27;s backendGroup must already be specified as a backend of
10739 # this backend service. Removing a backend that is designated as the
10740 # leader&#x27;s backendGroup is not permitted.
10741 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
10742 # designated as the leader.
10743 #
10744 # This network endpoint cannot be detached from the NEG specified in
10745 # the haPolicy.leader.backendGroup until the leader is updated with
10746 # another network endpoint, or the leader is removed from the haPolicy.
10747 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
10748 # instance must already be attached to the NEG specified in the
10749 # haPolicy.leader.backendGroup.
10750 #
10751 # The name must be 1-63 characters long, and comply with RFC1035.
10752 # Authorization requires the following IAM permission on the
10753 # specified resource instance: compute.instances.use
10754 },
10755 },
10756 },
10757 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
10758 # httpsHealthChecks (legacy) resource for health checking this backend
10759 # service. Not all backend services support legacy health checks. See
10760 # Load balancer guide. Currently, at most one health check can be
10761 # specified for each backend service. Backend services with
10762 # instance group or zonal NEG backends must have a health check unless
10763 # haPolicy is specified. Backend services with internet or serverless NEG
10764 # backends must not have a health check.
10765 #
10766 # healthChecks[] cannot be specified with haPolicy.
10767 &quot;A String&quot;,
10768 ],
10769 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
10770 # Not available for internal passthrough Network Load Balancers and external
10771 # passthrough Network Load Balancers.
10772 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
10773 # incoming requests.
10774 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
10775 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
10776 # for IAP.
10777 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
10778 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
10779 # Optional - If not provided, the name will be autogenerated by the
10780 # backend.
10781 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
10782 },
10783 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
10784 # For security reasons, this value cannot be retrieved via the API.
10785 # Instead, the SHA-256 hash of the value is returned in the
10786 # oauth2ClientSecretSha256 field.
10787 #
10788 # @InputOnly
10789 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
10790 },
10791 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
10792 # defined by the server.
10793 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
10794 # from the client to the backend for proxyless gRPC).
10795 # The possible values are:
10796 #
10797 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
10798 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10799 # Group), regardless of traffic from the client to the proxy. Only IPv4
10800 # health checks are used to check the health of the backends. This is the
10801 # default setting.
10802 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
10803 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
10804 # address).
10805 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
10806 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10807 # Group), regardless of traffic from the client to the proxy. Only IPv6
10808 # health checks are used to check the health of the backends.
10809 #
10810 #
10811 #
10812 # This field is applicable to either:
10813 #
10814 # - Advanced global external Application Load Balancer (load balancing
10815 # scheme EXTERNAL_MANAGED),
10816 # - Regional external Application Load
10817 # Balancer,
10818 # - Internal proxy Network Load Balancer (load balancing
10819 # scheme INTERNAL_MANAGED),
10820 # - Regional internal Application Load
10821 # Balancer (load balancing scheme INTERNAL_MANAGED),
10822 # - Traffic
10823 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
10824 # INTERNAL_SELF_MANAGED).
10825 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
10826 # for backend services.
10827 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
10828 # created for one type of load balancer cannot be used with another.
10829 # For more information, refer toChoosing
10830 # a load balancer.
10831 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
10832 # preference. When you use localityLbPolicies, you must set at least one
10833 # value for either the localityLbPolicies[].policy or the
10834 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
10835 # value set in the localityLbPolicy field.
10836 #
10837 # For an example of how to use this field, seeDefine
10838 # a list of preferred policies.
10839 #
10840 # Caution: This field and its children are intended for use in a service mesh
10841 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
10842 # that have this configuration.
10843 { # Container for either a built-in LB policy supported by gRPC or Envoy or
10844 # a custom one implemented by the end user.
10845 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
10846 # deployed with the client.
10847 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
10848 # by a locally installed custom policy implementation.
10849 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
10850 #
10851 # The value should match the name of a custom implementation registered
10852 # on the gRPC clients. It should follow protocol buffer message naming
10853 # conventions and include the full path (for example,
10854 # myorg.CustomLbPolicy). The maximum length is 256 characters.
10855 #
10856 # Do not specify the same custom policy more than once for a
10857 # backend. If you do, the configuration is rejected.
10858 #
10859 # For an example of how to use this field, seeUse
10860 # a custom policy.
10861 },
10862 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
10863 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
10864 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
10865 # about these values, see the description of localityLbPolicy.
10866 #
10867 # Do not specify the same policy more than once for a
10868 # backend. If you do, the configuration is rejected.
10869 },
10870 },
10871 ],
10872 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
10873 # possible values are:
10874 #
10875 # - ROUND_ROBIN: This is a simple policy in which each healthy
10876 # backend is selected in round robin order. This is the default.
10877 # - LEAST_REQUEST: An O(1) algorithm which
10878 # selects two random healthy hosts and picks the host which has fewer active
10879 # requests.
10880 # - RING_HASH: The ring/modulo hash load balancer implements
10881 # consistent hashing to backends. The algorithm has the property that the
10882 # addition/removal of a host from a set of N hosts only affects 1/N of the
10883 # requests.
10884 # - RANDOM: The load balancer selects a random healthy
10885 # host.
10886 # - ORIGINAL_DESTINATION: Backend host is selected
10887 # based on the client connection metadata, i.e., connections are opened to
10888 # the same address as the destination address of the incoming connection
10889 # before the connection was redirected to the load balancer.
10890 # - MAGLEV: used as a drop in replacement for the ring hash
10891 # load balancer. Maglev is not as stable as ring hash but has faster table
10892 # lookup build times and host selection times. For more information about
10893 # Maglev, see Maglev:
10894 # A Fast and Reliable Software Network Load Balancer.
10895 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
10896 # Load Balancing using weights computed from Backend reported Custom Metrics.
10897 # If set, the Backend Service responses are expected to contain non-standard
10898 # HTTP response header field Endpoint-Load-Metrics. The reported
10899 # metrics to use for computing the weights are specified via thecustomMetrics field.
10900 #
10901 # This field is applicable to either:
10902 # - A regional backend service with the service protocol set to HTTP,
10903 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10904 # INTERNAL_MANAGED.
10905 # - A global backend service with the
10906 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
10907 # EXTERNAL_MANAGED.
10908 #
10909 #
10910 # If sessionAffinity is not configured—that is, if session
10911 # affinity remains at the default value of NONE—then the
10912 # default value for localityLbPolicy
10913 # is ROUND_ROBIN. If session affinity is set to a value other
10914 # than NONE,
10915 # then the default value for localityLbPolicy isMAGLEV.
10916 #
10917 # Only ROUND_ROBIN and RING_HASH are supported
10918 # when the backend service is referenced by a URL map that is bound to
10919 # target gRPC proxy that has validateForProxyless field set to true.
10920 #
10921 # localityLbPolicy cannot be specified with haPolicy.
10922 &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
10923 # by this backend service. If logging is enabled, logs will be exported to
10924 # Stackdriver.
10925 # backend service.
10926 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
10927 # traffic served by this backend service. The default value is false.
10928 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
10929 { # Determines which HTTP headers will be logged to Stackdriver.
10930 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10931 },
10932 ],
10933 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
10934 { # Determines which HTTP headers will be logged to Stackdriver.
10935 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10936 },
10937 ],
10938 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
10939 # This field can only be specified if logging is enabled for this backend
10940 # service. Configures whether all, none or a subset of optional fields
10941 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
10942 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
10943 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
10944 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
10945 # of optional fields you want to include in the logs. For example:
10946 # serverInstance, serverGkeDetails.cluster,
10947 # serverGkeDetails.pod.podNamespace
10948 &quot;A String&quot;,
10949 ],
10950 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
10951 # service. Configures whether all, none or a subset of optional fields
10952 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
10953 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
10954 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
10955 # service. The value of the field must be in [0, 1]. This configures the
10956 # sampling rate of requests to the load balancer where 1.0 means all logged
10957 # requests are reported and 0.0 means no logged requests are reported. The
10958 # default value is 1.0.
10959 },
10960 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
10961 # service. Duration is computed from the beginning of the stream until the
10962 # response has been completely processed, including all retries. A stream
10963 # that does not complete in this duration is closed.
10964 #
10965 # If not specified, there will be no timeout limit, i.e. the maximum
10966 # duration is infinite.
10967 #
10968 # This value can be overridden in the PathMatcher configuration of the
10969 # UrlMap that references this backend service.
10970 #
10971 # This field is only allowed when the loadBalancingScheme of
10972 # the backend service is INTERNAL_SELF_MANAGED.
10973 # as a count of seconds and fractions of seconds at nanosecond
10974 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10975 # or &quot;month&quot;. Range is approximately 10,000 years.
10976 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10977 # Durations less than one second are represented with a 0
10978 # `seconds` field and a positive `nanos` field. Must be from 0
10979 # to 999,999,999 inclusive.
10980 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10981 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10982 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10983 },
10984 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
10985 # controller and read by the backend RCTH
10986 &quot;a_key&quot;: &quot;A String&quot;,
10987 },
10988 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
10989 # The name must be 1-63 characters long, and comply withRFC1035.
10990 # Specifically, the name must be 1-63 characters long and match the regular
10991 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10992 # character must be a lowercase letter, and all following characters must
10993 # be a dash, lowercase letter, or digit, except the last character, which
10994 # cannot be a dash.
10995 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
10996 #
10997 # This field must be set for Internal Passthrough Network Load Balancers when
10998 # the haPolicy is enabled, and for External Passthrough Network Load
10999 # Balancers when the haPolicy fastIpMove is enabled.
11000 #
11001 # 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.
11002 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
11003 # Load Balancers.
11004 #
11005 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
11006 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
11007 # endpoints in the local zone.
11008 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
11009 # possible values are:
11010 #
11011 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
11012 # is disabled. The load balancer distributes new connections to all
11013 # healthy backend endpoints across all zones.
11014 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
11015 # enabled. The load balancer distributes new connections to all healthy
11016 # backend endpoints in the local zone only. If there are no healthy
11017 # backend endpoints in the local zone, the load balancer distributes
11018 # new connections to all backend endpoints in the local zone.
11019 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
11020 # enabled. The load balancer distributes new connections to all healthy
11021 # backend endpoints in the local zone only. If there aren&#x27;t enough
11022 # healthy backend endpoints in the local zone, the load balancer
11023 # distributes new connections to all healthy backend endpoints across all
11024 # zones.
11025 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
11026 # of healthy backend endpoints in a zone to the count of backend
11027 # endpoints in that same zone is equal to or above this threshold, the
11028 # load balancer distributes new connections to all healthy endpoints in
11029 # the local zone only. When the ratio of the count of healthy backend
11030 # endpoints in a zone to the count of backend endpoints in that same
11031 # zone is below this threshold, the load balancer distributes all new
11032 # connections to all healthy endpoints across all zones.
11033 },
11034 },
11035 &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.
11036 # the backend service.
11037 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
11038 # service.
11039 },
11040 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
11041 # load balancing pool of each individual proxy instance that processes the
11042 # traffic for the given backend service. If not set, this feature is
11043 # considered disabled.
11044 #
11045 # Results of the outlier detection algorithm (ejection of endpoints from the
11046 # load balancing pool and returning them back to the pool) are executed
11047 # independently by each proxy instance of the load balancer. In most cases,
11048 # more than one proxy instance handles the traffic received by a backend
11049 # service. Thus, it is possible that an unhealthy endpoint is detected and
11050 # ejected by only some of the proxies, and while this happens, other proxies
11051 # may continue to send requests to the same unhealthy endpoint until they
11052 # detect and eject the unhealthy endpoint.
11053 #
11054 # Applicable backend endpoints can be:
11055 #
11056 # - VM instances in an Instance Group
11057 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
11058 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
11059 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
11060 # Functions Services
11061 # - Private Service Connect NEGs, that resolve to
11062 # Google-managed regional API endpoints or managed services published using
11063 # Private Service Connect
11064 #
11065 #
11066 #
11067 # Applicable backend service types can be:
11068 #
11069 # - A global backend service with the loadBalancingScheme set to
11070 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
11071 # - A regional backend
11072 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
11073 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
11074 # supported for Serverless NEGs.
11075 #
11076 #
11077 #
11078 # Not supported when the backend service is referenced by a URL map that is
11079 # bound to target gRPC proxy that has validateForProxyless field set to true.
11080 # pool for the backend service.
11081 &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
11082 # or 30s.
11083 #
11084 # After a backend endpoint is returned back to the load balancing pool, it
11085 # can be ejected again in another ejection analysis. Thus, the total ejection
11086 # time is equal to the base ejection time multiplied by the number of times
11087 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
11088 # as a count of seconds and fractions of seconds at nanosecond
11089 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11090 # or &quot;month&quot;. Range is approximately 10,000 years.
11091 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11092 # Durations less than one second are represented with a 0
11093 # `seconds` field and a positive `nanos` field. Must be from 0
11094 # to 999,999,999 inclusive.
11095 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11096 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11097 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11098 },
11099 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
11100 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
11101 # return code qualifies as an error. Defaults to 5.
11102 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
11103 # connection errors that are mapped to one of those status codes) before a
11104 # consecutive gateway failure ejection occurs. Defaults to 3.
11105 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
11106 # outlier status is detected through consecutive 5xx. This setting can be
11107 # used to disable ejection or to ramp it up slowly. Defaults to 0.
11108 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
11109 # outlier status is detected through consecutive gateway failures. This
11110 # setting can be used to disable ejection or to ramp it up slowly. Defaults
11111 # to 100.
11112 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
11113 # outlier status is detected through success rate statistics. This setting
11114 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
11115 #
11116 # Not supported when the backend service uses Serverless NEG.
11117 &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
11118 # ejections and backend endpoints being returned to service. The interval is
11119 # equal to the number of seconds as defined in
11120 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
11121 # in outlierDetection.interval.nanos. Defaults to 1 second.
11122 # as a count of seconds and fractions of seconds at nanosecond
11123 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11124 # or &quot;month&quot;. Range is approximately 10,000 years.
11125 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11126 # Durations less than one second are represented with a 0
11127 # `seconds` field and a positive `nanos` field. Must be from 0
11128 # to 999,999,999 inclusive.
11129 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11130 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11131 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11132 },
11133 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
11134 # backend service that can be ejected if the ejection conditions are met.
11135 # Defaults to 50%.
11136 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
11137 # enough request volume to detect success rate outliers. If the number of
11138 # backend endpoints is fewer than this setting, outlier detection via success
11139 # rate statistics is not performed for any backend endpoint in the load
11140 # balancing pool. Defaults to 5.
11141 #
11142 # Not supported when the backend service uses Serverless NEG.
11143 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
11144 # (as defined by the interval duration above) to include this backend
11145 # endpoint in success rate based outlier detection. If the volume is lower
11146 # than this setting, outlier detection via success rate statistics is not
11147 # performed for that backend endpoint. Defaults to 100.
11148 #
11149 # Not supported when the backend service uses Serverless NEG.
11150 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
11151 # outlier ejection. The ejection threshold is the difference between the mean
11152 # success rate, and the product of this factor and the standard deviation of
11153 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
11154 # is divided by a thousand to get a double. That is, if the desired factor
11155 # is 1.9, the runtime value should be 1900. Defaults to 1900.
11156 #
11157 # Not supported when the backend service uses Serverless NEG.
11158 },
11159 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
11160 # as part of resource payload.
11161 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
11162 # Tag keys and values have the same definition as resource
11163 # manager tags. The field is allowed for INSERT
11164 # only. The keys/values to set on the resource should be specified in
11165 # either ID { : } or Namespaced format
11166 # { : }.
11167 # For example the following are valid inputs:
11168 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
11169 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
11170 # Note:
11171 # * Invalid combinations of ID &amp; namespaced format is not supported. For
11172 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
11173 &quot;a_key&quot;: &quot;A String&quot;,
11174 },
11175 },
11176 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
11177 # the backend. The default value is 80.
11178 # For internal passthrough Network Load Balancers and external passthrough
11179 # Network Load Balancers, omit port.
11180 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
11181 # communication to the backend VMs in that group. The
11182 # named port must be [defined on each backend instance
11183 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
11184 # This parameter has no meaning if the backends are NEGs. For internal
11185 # passthrough Network Load Balancers and external passthrough Network Load
11186 # Balancers, omit port_name.
11187 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
11188 # with backends.
11189 #
11190 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
11191 # depending on the chosen load balancer or Traffic Director configuration.
11192 # Refer to the documentation for the load balancers or for Traffic Director
11193 # for more information.
11194 #
11195 # Must be set to GRPC when the backend service is referenced by a URL map
11196 # that is bound to target gRPC proxy.
11197 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
11198 # resides. This field is not applicable to global backend services.
11199 # You must specify this field as part of the HTTP request URL. It is
11200 # not settable as a field in the request body.
11201 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
11202 # backend service.
11203 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
11204 # service. This field is applicable to a global backend service with the
11205 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
11206 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
11207 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
11208 # be accepted on backends, and if authenticated, which method/certificate
11209 # will set the request principal.
11210 # request principal.
11211 # The authentication settings for the backend service.
11212 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
11213 # Similar to peers, these will be evaluated in order the first valid one
11214 # will be used to set origin identity. If none of these methods pass, the
11215 # request will be rejected with authentication failed error (401). Leave the
11216 # list empty if origin authentication is not required.
11217 { # [Deprecated] Configuration for the origin authentication method.
11218 # Configuration for the origin authentication method.
11219 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
11220 # JWT configuration for origin authentication.
11221 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
11222 # will be accepted if audiences is empty.
11223 # Examples: bookstore_android.apps.googleusercontent.com,
11224 # bookstore_web.apps.googleusercontent.com
11225 &quot;A String&quot;,
11226 ],
11227 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
11228 # email address.
11229 # Examples: https://securetoken.google.com,
11230 # [email protected]
11231 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
11232 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
11233 # request. If no explicit location is specified, the following default
11234 # locations are tried in order:
11235 #
11236 # 1. The Authorization header using the Bearer schema. See `here
11237 # `_. Example:
11238 #
11239 # Authorization: Bearer .
11240 #
11241 # 2. `access_token` query parameter. See `this
11242 # `_
11243 #
11244 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
11245 # from the locations its issuer specified or from the default locations.
11246 #
11247 # This field is set if JWT is sent in a request header. This field specifies
11248 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
11249 # header format will be x-goog-iap-jwt-assertion: .
11250 { # [Deprecated] This message specifies a header location to extract JWT token.
11251 # This message specifies a header location to extract JWT token.
11252 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
11253 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
11254 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
11255 # with a space at the end.
11256 },
11257 ],
11258 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
11259 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
11260 # JWT format in the query parameter is /path?jwt_token=.
11261 &quot;A String&quot;,
11262 ],
11263 },
11264 },
11265 ],
11266 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
11267 # They will be evaluated in order the first valid one will be used to set
11268 # peer identity. If none of these methods pass, the request will be rejected
11269 # with authentication failed error (401). Leave the list empty if peer
11270 # authentication is not required.
11271 { # [Deprecated] Configuration for the peer authentication method.
11272 # Configuration for the peer authentication method.
11273 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
11274 # Configuration for the mutual Tls mode for peer authentication.
11275 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
11276 # field can be set to one of the following:
11277 # STRICT: Client certificate must be presented, connection is in TLS.
11278 # PERMISSIVE: Client certificate can be omitted, connection can be either
11279 # plaintext or TLS.
11280 },
11281 },
11282 ],
11283 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
11284 # Default value is USE_PEER. If peer (or origin) identity is not available,
11285 # either because peer/origin authentication is not defined, or failed,
11286 # principal will be left unset. In other words, binding rule does not affect
11287 # the decision to accept or reject request. This field can be set to one of
11288 # the following:
11289 # USE_PEER: Principal will be set to the identity from peer authentication.
11290 # USE_ORIGIN: Principal will be set to the identity from origin
11291 # authentication.
11292 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
11293 # identity information.
11294 # The TLS settings for the client or server.
11295 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
11296 # certificate.
11297 # Defines the mechanism to obtain the client or server certificate.
11298 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
11299 # applicable only if tlsCertificateSource is set to USE_PATH.
11300 # The paths to the mounted TLS Certificates and private key.
11301 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
11302 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
11303 },
11304 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
11305 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
11306 # is applicable only if tlsCertificateSource is set to USE_SDS.
11307 # The configuration to access the SDS server.
11308 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
11309 # gRPC config to access the SDS server.
11310 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
11311 # gRPC call credentials to access the SDS server.
11312 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
11313 # This field can be set to one of the following:
11314 #
11315 # - GCE_VM: The local GCE VM service account credentials are used to access
11316 # the SDS server.
11317 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
11318 # SDS server.
11319 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
11320 # FROM_PLUGIN.
11321 # Custom authenticator credentials.
11322 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
11323 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
11324 # plugin.
11325 },
11326 },
11327 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
11328 # gRPC channel credentials to access the SDS server.
11329 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
11330 # The paths to the mounted TLS Certificates and private key.
11331 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
11332 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
11333 },
11334 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
11335 # to one of the following:
11336 # CERTIFICATES: Use TLS certificates to access the SDS server.
11337 # GCE_VM: Use local GCE VM credentials to access the SDS server.
11338 },
11339 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
11340 },
11341 },
11342 },
11343 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
11344 # validate the client/server certificate. If omitted, the proxy will not
11345 # validate the server or client certificate.
11346 # certificate to validate the client/server certificate.
11347 # validate the client/server certificate.
11348 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
11349 # client or server certificate.
11350 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
11351 # is applicable only if tlsCertificateSource is set to USE_SDS.
11352 # The configuration to access the SDS server.
11353 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
11354 # gRPC config to access the SDS server.
11355 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
11356 # gRPC call credentials to access the SDS server.
11357 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
11358 # This field can be set to one of the following:
11359 #
11360 # - GCE_VM: The local GCE VM service account credentials are used to access
11361 # the SDS server.
11362 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
11363 # SDS server.
11364 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
11365 # FROM_PLUGIN.
11366 # Custom authenticator credentials.
11367 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
11368 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
11369 # plugin.
11370 },
11371 },
11372 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
11373 # gRPC channel credentials to access the SDS server.
11374 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
11375 # The paths to the mounted TLS Certificates and private key.
11376 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
11377 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
11378 },
11379 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
11380 # to one of the following:
11381 # CERTIFICATES: Use TLS certificates to access the SDS server.
11382 # GCE_VM: Use local GCE VM credentials to access the SDS server.
11383 },
11384 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
11385 },
11386 },
11387 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
11388 },
11389 },
11390 },
11391 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
11392 # (RBAC) config.
11393 # Authorization config defines the Role Based Access Control (RBAC) config.
11394 # method-level access control for a service.
11395 # control for a service.
11396 &quot;policies&quot;: [ # List of RbacPolicies.
11397 {
11398 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
11399 &quot;permissions&quot;: [ # The list of permissions.
11400 { # [Deprecated] All fields defined in a permission are ANDed.
11401 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
11402 { # Custom constraint that specifies a key and a list of allowed values for
11403 # Istio attributes.
11404 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
11405 &quot;values&quot;: [ # A list of allowed values.
11406 &quot;A String&quot;,
11407 ],
11408 },
11409 ],
11410 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
11411 # applies to. Exact match, prefix match, and suffix match are supported.
11412 &quot;A String&quot;,
11413 ],
11414 &quot;methods&quot;: [ # HTTP method.
11415 &quot;A String&quot;,
11416 ],
11417 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
11418 &quot;A String&quot;,
11419 ],
11420 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
11421 &quot;A String&quot;,
11422 ],
11423 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
11424 &quot;A String&quot;,
11425 ],
11426 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
11427 &quot;A String&quot;,
11428 ],
11429 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
11430 # Exact match, prefix match, and suffix match are supported.
11431 &quot;A String&quot;,
11432 ],
11433 &quot;ports&quot;: [ # Port names or numbers.
11434 &quot;A String&quot;,
11435 ],
11436 },
11437 ],
11438 &quot;principals&quot;: [ # The list of principals.
11439 { # [Deprecated] All fields defined in a principal are ANDed.
11440 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
11441 &quot;groups&quot;: [ # The groups the principal belongs to.
11442 # Exact match, prefix match, and suffix match are supported.
11443 &quot;A String&quot;,
11444 ],
11445 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
11446 &quot;A String&quot;,
11447 ],
11448 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
11449 &quot;A String&quot;,
11450 ],
11451 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
11452 &quot;A String&quot;,
11453 ],
11454 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
11455 &quot;A String&quot;,
11456 ],
11457 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
11458 &quot;A String&quot;,
11459 ],
11460 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
11461 &quot;A String&quot;,
11462 ],
11463 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
11464 # suffix match are supported for values. For example,
11465 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
11466 &quot;a_key&quot;: &quot;A String&quot;,
11467 },
11468 &quot;users&quot;: [ # The user names/IDs or service accounts.
11469 # Exact match, prefix match, and suffix match are supported.
11470 &quot;A String&quot;,
11471 ],
11472 },
11473 ],
11474 },
11475 ],
11476 },
11477 &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
11478 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
11479 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
11480 # private storage buckets that support Signature Version 4 for authentication.
11481 # The service name for generating the authentication header will always default
11482 # to &#x27;s3&#x27;.
11483 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
11484 # creating a backend that uses AWS v4 signature authentication, but will not
11485 # be returned as part of the configuration when queried with a REST API GET
11486 # request.
11487 #
11488 # @InputOnly
11489 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
11490 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
11491 # keep track of different iterations of your access key.
11492 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
11493 # the name of the region your cloud uses to host your origin. For example,
11494 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
11495 },
11496 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
11497 # that describes how clients should authenticate with this service&#x27;s
11498 # backends.
11499 #
11500 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
11501 # to INTERNAL_SELF_MANAGED.
11502 #
11503 # If left blank, communications are not encrypted.
11504 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
11505 # originating from the backend service.
11506 # the backend service.
11507 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
11508 # identity information. This field is only applicable when mode is set to
11509 # MUTUAL.
11510 # The TLS settings for the client or server.
11511 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
11512 # certificate.
11513 # Defines the mechanism to obtain the client or server certificate.
11514 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
11515 # applicable only if tlsCertificateSource is set to USE_PATH.
11516 # The paths to the mounted TLS Certificates and private key.
11517 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
11518 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
11519 },
11520 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
11521 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
11522 # is applicable only if tlsCertificateSource is set to USE_SDS.
11523 # The configuration to access the SDS server.
11524 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
11525 # gRPC config to access the SDS server.
11526 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
11527 # gRPC call credentials to access the SDS server.
11528 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
11529 # This field can be set to one of the following:
11530 #
11531 # - GCE_VM: The local GCE VM service account credentials are used to access
11532 # the SDS server.
11533 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
11534 # SDS server.
11535 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
11536 # FROM_PLUGIN.
11537 # Custom authenticator credentials.
11538 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
11539 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
11540 # plugin.
11541 },
11542 },
11543 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
11544 # gRPC channel credentials to access the SDS server.
11545 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
11546 # The paths to the mounted TLS Certificates and private key.
11547 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
11548 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
11549 },
11550 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
11551 # to one of the following:
11552 # CERTIFICATES: Use TLS certificates to access the SDS server.
11553 # GCE_VM: Use local GCE VM credentials to access the SDS server.
11554 },
11555 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
11556 },
11557 },
11558 },
11559 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
11560 # validate the client/server certificate. If omitted, the proxy will not
11561 # validate the server or client certificate.
11562 # certificate to validate the client/server certificate.
11563 # validate the client/server certificate.
11564 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
11565 # client or server certificate.
11566 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
11567 # is applicable only if tlsCertificateSource is set to USE_SDS.
11568 # The configuration to access the SDS server.
11569 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
11570 # gRPC config to access the SDS server.
11571 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
11572 # gRPC call credentials to access the SDS server.
11573 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
11574 # This field can be set to one of the following:
11575 #
11576 # - GCE_VM: The local GCE VM service account credentials are used to access
11577 # the SDS server.
11578 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
11579 # SDS server.
11580 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
11581 # FROM_PLUGIN.
11582 # Custom authenticator credentials.
11583 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
11584 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
11585 # plugin.
11586 },
11587 },
11588 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
11589 # gRPC channel credentials to access the SDS server.
11590 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
11591 # The paths to the mounted TLS Certificates and private key.
11592 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
11593 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
11594 },
11595 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
11596 # to one of the following:
11597 # CERTIFICATES: Use TLS certificates to access the SDS server.
11598 # GCE_VM: Use local GCE VM credentials to access the SDS server.
11599 },
11600 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
11601 },
11602 },
11603 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
11604 },
11605 },
11606 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
11607 # The value of this field determines how TLS is enforced. This can be set
11608 # to one of the following values: DISABLE: Do not setup a TLS connection to
11609 # the backends.
11610 # SIMPLE: Originate a TLS connection to the backends.
11611 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
11612 # client certificates for authentication.
11613 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
11614 # applicable only when mode is SIMPLE or MUTUAL.
11615 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
11616 # certificate.If specified,
11617 # the proxy will verify that the server certificate&#x27;s subject alt name
11618 # matches one of the specified values. This field is applicable only when
11619 # mode is SIMPLE or MUTUAL.
11620 &quot;A String&quot;,
11621 ],
11622 },
11623 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
11624 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
11625 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
11626 # specified values, the communication continues. Otherwise, it fails. This
11627 # additional check enables the client to verify that the server is authorized
11628 # to run the requested service.
11629 #
11630 # Note that the contents of the server
11631 # certificate&#x27;s subjectAltName field are configured by the
11632 # Public Key Infrastructure which provisions server identities.
11633 #
11634 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
11635 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
11636 # mode).
11637 &quot;A String&quot;,
11638 ],
11639 },
11640 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11641 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
11642 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
11643 #
11644 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
11645 # If set, lists of backends and health checks must be both empty.
11646 &quot;A String&quot;,
11647 ],
11648 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
11649 #
11650 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
11651 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
11652 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
11653 #
11654 # Only NONE and HEADER_FIELD are supported
11655 # when the backend service is referenced by a URL map that is bound to
11656 # target gRPC proxy that has validateForProxyless field set to true.
11657 #
11658 # For more details, see:
11659 # [Session
11660 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
11661 #
11662 # sessionAffinity cannot be specified with haPolicy.
11663 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
11664 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
11665 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
11666 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
11667 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
11668 # as a count of seconds and fractions of seconds at nanosecond
11669 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11670 # or &quot;month&quot;. Range is approximately 10,000 years.
11671 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11672 # Durations less than one second are represented with a 0
11673 # `seconds` field and a positive `nanos` field. Must be from 0
11674 # to 999,999,999 inclusive.
11675 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11676 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11677 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11678 },
11679 },
11680 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
11681 # Currently this is applicable only for Internal TCP/UDP load balancing,
11682 # Internal HTTP(S) load balancing and Traffic Director.
11683 &quot;policy&quot;: &quot;A String&quot;,
11684 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
11685 # each service mesh client.
11686 #
11687 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
11688 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
11689 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
11690 # `INTERNAL_SELF_MANAGED`.
11691 #
11692 # `subset_size` is optional for Internal HTTP(S) load balancing
11693 # and required for Traffic Director.
11694 #
11695 # If you do not provide this value, Cloud Load Balancing will calculate it
11696 # dynamically to optimize the number of proxies/clients visible to each
11697 # backend and vice versa.
11698 #
11699 # Must be greater than 0. If `subset_size` is larger than the number of
11700 # backends/endpoints, then subsetting is disabled.
11701 },
11702 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
11703 # type of load balancer. For more information see,
11704 # Backend service settings.
11705 # The default is 30 seconds.
11706 # The full range of timeout values allowed goes from 1
11707 # through 2,147,483,647 seconds.
11708 #
11709 # This value can be overridden in the PathMatcher configuration of the
11710 # UrlMap that references this backend service.
11711 #
11712 # Not supported when the backend service is referenced by a URL map that is
11713 # bound to target gRPC proxy that has validateForProxyless field set to true.
11714 # Instead, use maxStreamDuration.
11715 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
11716 # when the backend protocol is SSL, HTTPS or HTTP2.
11717 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
11718 # networksecurity.googleapis.com namespace. Can be used in authenticating
11719 # TLS connections to the backend, as specified by the authenticationMode
11720 # field. Can only be specified if authenticationMode is not NONE.
11721 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
11722 #
11723 #
11724 # Use this property to configure the load balancer back-end to use
11725 # certificates and roots of trust provisioned by the Managed Workload
11726 # Identity system.
11727 #
11728 # The `identity` property is the
11729 # fully-specified SPIFFE ID to use in the SVID presented by the Load
11730 # Balancer Workload.
11731 #
11732 # The SPIFFE ID must be a resource starting with the
11733 # `trustDomain` property value, followed by the path to the Managed
11734 # Workload Identity.
11735 #
11736 # Supported SPIFFE ID format:
11737 #
11738 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
11739 #
11740 #
11741 # The Trust Domain within the Managed Identity must refer to a valid
11742 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
11743 # will be inherited from the Workload Identity Pool.
11744 #
11745 # Restrictions:
11746 #
11747 # - If you set the `identity` property, you cannot manually set
11748 # the following fields:
11749 # - tlsSettings.sni
11750 # - tlsSettings.subjectAltNames
11751 # - tlsSettings.authenticationConfig
11752 #
11753 #
11754 # When defining a `identity` for a RegionBackendServices, the
11755 # corresponding Workload Identity Pool must have a ca_pool
11756 # configured in the same region.
11757 #
11758 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
11759 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
11760 # balancer sends this string as the SNI hostname in the TLS connection to
11761 # the backend, and requires that this string match a Subject Alternative
11762 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
11763 # NEG backend, if the SNI is specified here, the load balancer uses it
11764 # regardless of whether the Regional Internet NEG is specified with FQDN or
11765 # IP address and port. When both sni and subjectAltNames[] are specified,
11766 # the load balancer matches the backend certificate&#x27;s SAN only to
11767 # subjectAltNames[].
11768 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
11769 # verifies during a TLS handshake with the backend. When the server
11770 # presents its X.509 certificate to the Load Balancer, the Load Balancer
11771 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
11772 # match one of the subjectAltNames in the list. This field is limited to 5
11773 # entries. When both sni and subjectAltNames[] are specified, the load
11774 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
11775 { # A Subject Alternative Name that the load balancer matches against the SAN
11776 # field in the TLS certificate provided by the backend, specified as either
11777 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
11778 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
11779 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
11780 },
11781 ],
11782 },
11783 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
11784 {
11785 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
11786 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
11787 # and ForwardingRule.
11788 },
11789 ],
11790 },
11791 ],
11792 &quot;kind&quot;: &quot;compute#usableBackendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend
11793 # services.
11794 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
11795 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
11796 # the query parameter pageToken in the next list request.
11797 # Subsequent list requests will have their own nextPageToken to
11798 # continue paging through the results.
11799 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
11800 &quot;warning&quot;: { # [Output Only] Informational warning message.
11801 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11802 # Engine returns NO_RESULTS_ON_PAGE if there
11803 # are no results in the response.
11804 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11805 # value format. For example:
11806 #
11807 # &quot;data&quot;: [
11808 # {
11809 # &quot;key&quot;: &quot;scope&quot;,
11810 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11811 # }
11812 {
11813 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11814 # returned. For example, for warnings where there are no results in a list
11815 # request for a particular zone, this key might be scope and
11816 # the key value might be the zone name. Other examples might be a key
11817 # indicating a deprecated resource and a suggested replacement, or a
11818 # warning about invalid network settings (for example, if an instance
11819 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11820 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11821 },
11822 ],
11823 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11824 },
11825 }</pre>
11826 </div>
11827
11828 <div class="method">
11829 <code class="details" id="listUsable_next">listUsable_next()</code>
11830 <pre>Retrieves the next page of results.
11831
11832 Args:
11833 previous_request: The request for the previous page. (required)
11834 previous_response: The response from the request for the previous page. (required)
11835
11836 Returns:
11837 A request object that you can call &#x27;execute()&#x27; on to request the next
11838 page. Returns None if there are no more items in the collection.
11839 </pre>
11840 </div>
11841
11842 <div class="method">
11843 <code class="details" id="list_next">list_next()</code>
11844 <pre>Retrieves the next page of results.
11845
11846 Args:
11847 previous_request: The request for the previous page. (required)
11848 previous_response: The response from the request for the previous page. (required)
11849
11850 Returns:
11851 A request object that you can call &#x27;execute()&#x27; on to request the next
11852 page. Returns None if there are no more items in the collection.
11853 </pre>
11854 </div>
11855
11856 <div class="method">
11857 <code class="details" id="patch">patch(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
11858 <pre>Patches the specified BackendService resource with the data included in the
11859 request. For more information, see
11860 Backend services overview. This method
11861 supports PATCH semantics and uses the JSON merge
11862 patch format and processing rules.
11863
11864 Args:
11865 project: string, Project ID for this request. (required)
11866 backendService: string, Name of the BackendService resource to patch. (required)
11867 body: object, The request body.
11868 The object takes the form of:
11869
11870 { # Represents a Backend Service resource.
11871 #
11872 # A backend service defines how Google Cloud load balancers distribute traffic.
11873 # The backend service configuration contains a set of values, such as the
11874 # protocol used to connect to backends, various distribution and session
11875 # settings, health checks, and timeouts. These settings provide fine-grained
11876 # control over how your load balancer behaves. Most of the settings have
11877 # default values that allow for easy configuration if you need to get started
11878 # quickly.
11879 #
11880 # Backend services in Google Compute Engine can be either regionally or
11881 # globally scoped.
11882 #
11883 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
11884 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
11885 #
11886 # For more information, seeBackend
11887 # Services.
11888 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
11889 # Load Balancers and Traffic Director and requires
11890 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
11891 #
11892 # If set to 0, the cookie is non-persistent and lasts only until
11893 # the end of the browser session (or equivalent). The maximum allowed value
11894 # is two weeks (1,209,600).
11895 #
11896 # Not supported when the backend service is referenced by a URL map that is
11897 # bound to target gRPC proxy that has validateForProxyless field set to true.
11898 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
11899 # load balancing scheme set to INTERNAL_SELF_MANAGED.
11900 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
11901 { # Message containing information of one individual backend.
11902 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
11903 # handle additional traffic or is fully loaded. For usage guidelines, see
11904 # Connection balancing mode.
11905 #
11906 # Backends must use compatible balancing modes. For more information, see
11907 # Supported balancing modes and target capacity settings and
11908 # Restrictions and guidance for instance groups.
11909 #
11910 # Note: Currently, if you use the API to configure incompatible balancing
11911 # modes, the configuration might be accepted even though it has no impact
11912 # and is ignored. Specifically, Backend.maxUtilization is ignored when
11913 # Backend.balancingMode is RATE. In the future, this incompatible combination
11914 # will be rejected.
11915 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
11916 # mode.
11917 # The default value is 1, which means the group serves up to
11918 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
11919 # completely drained, offering 0% of its available capacity. The valid ranges
11920 # are 0.0 and [0.1,1.0].
11921 # You cannot configure a setting larger than 0 and smaller than0.1.
11922 # You cannot configure a setting of 0 when there is only one
11923 # backend attached to the backend service.
11924 #
11925 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
11926 # internet NEGs, regional serverless NEGs, and PSC NEGs.
11927 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
11928 # BalancingMode.
11929 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
11930 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
11931 # Monitoring, but is not used for load balancing.
11932 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
11933 # balancing mode. The valid range is [0.0, 1.0].
11934 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
11935 # long and match the regular expression
11936 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
11937 # first character must be a lowercase letter, and all following
11938 # characters must be a dash, period, underscore, lowercase letter, or
11939 # digit, except the last character, which cannot be a dash, period, or
11940 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
11941 # field can only be used for a global or regional backend service with the
11942 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
11943 },
11944 ],
11945 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
11946 # create the resource.
11947 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
11948 # failover backend can be configured for a given BackendService.
11949 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
11950 # group or network endpoint
11951 # group (NEG) resource. To determine what types of backends a load
11952 # balancer supports, see the [Backend services
11953 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
11954 #
11955 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
11956 # or NEG. Partial URLs are not supported.
11957 #
11958 # If haPolicy is specified, backends must refer to NEG resources of type
11959 # GCE_VM_IP.
11960 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
11961 # guidelines, seeConnection
11962 # balancing mode and Utilization
11963 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
11964 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
11965 # guidelines, seeConnection
11966 # balancing mode and Utilization
11967 # balancing mode.
11968 #
11969 # Not available if the backend&#x27;s balancingMode isRATE.
11970 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
11971 # For usage guidelines, seeConnection
11972 # balancing mode and Utilization
11973 # balancing mode.
11974 #
11975 # Not available if the backend&#x27;s balancingMode isRATE.
11976 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
11977 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
11978 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
11979 # Not available if backend&#x27;s balancingMode is RATE
11980 # or CONNECTION.
11981 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
11982 # Not available if backend&#x27;s balancingMode is RATE
11983 # or CONNECTION.
11984 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
11985 # usage guidelines, seeRate
11986 # balancing mode and Utilization
11987 # balancing mode.
11988 #
11989 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11990 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
11991 # guidelines, seeRate
11992 # balancing mode and Utilization
11993 # balancing mode.
11994 #
11995 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11996 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
11997 # guidelines, seeRate
11998 # balancing mode and Utilization
11999 # balancing mode.
12000 #
12001 # Not available if the backend&#x27;s balancingMode isCONNECTION.
12002 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
12003 #
12004 # For usage guidelines, seeUtilization
12005 # balancing mode.
12006 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
12007 # the backend.
12008 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
12009 },
12010 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
12011 # sending traffic to backends with default preference. The possible values
12012 # are:
12013 #
12014 # - PREFERRED: Backends with this preference level will be
12015 # filled up to their capacity limits first, based on RTT.
12016 # - DEFAULT: If preferred backends don&#x27;t have enough
12017 # capacity, backends in this layer would be used and traffic would be
12018 # assigned based on the load balancing algorithm you use. This is the
12019 # default
12020 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
12021 # Attachment).
12022 # e.g.
12023 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
12024 # for Cloud Run service.
12025 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
12026 # for PSC Service Attachment.
12027 &quot;trafficDuration&quot;: &quot;A String&quot;,
12028 },
12029 ],
12030 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
12031 # specified load balancer types.
12032 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
12033 # Pragma or Authorization headers. Up to 5 headers can be specified.
12034 # The cache is bypassed for all cdnPolicy.cacheMode settings.
12035 { # Bypass the cache when the specified request headers are present,
12036 # e.g. Pragma or Authorization headers. Values are case insensitive.
12037 # The presence of such a header overrides the cache_mode setting.
12038 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
12039 # Values are case-insensitive.
12040 },
12041 ],
12042 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
12043 # CDN.
12044 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
12045 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
12046 &quot;A String&quot;,
12047 ],
12048 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
12049 # The name=value pair will be used in the cache key Cloud CDN generates.
12050 &quot;A String&quot;,
12051 ],
12052 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
12053 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
12054 # query_string_whitelist and query_string_blacklist. If neither is set, the
12055 # entire query string will be included. If false, the query string will be
12056 # excluded from the cache key entirely.
12057 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
12058 # parameters will be included. Either specify query_string_whitelist or
12059 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
12060 # not treated as delimiters.
12061 &quot;A String&quot;,
12062 ],
12063 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
12064 # parameters will be excluded. Either specify query_string_whitelist or
12065 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
12066 # not treated as delimiters.
12067 &quot;A String&quot;,
12068 ],
12069 },
12070 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
12071 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
12072 # headers to cache content. Responses without these headers will not be
12073 # cached at Google&#x27;s edge, and will require a full trip to the origin on
12074 # every request, potentially impacting performance and increasing load on
12075 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
12076 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
12077 # Warning: this may result in Cloud CDN caching private,
12078 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
12079 # including common image formats, media (video and audio), and web assets
12080 # (JavaScript and CSS). Requests and responses that are marked as
12081 # uncacheable, as well as dynamic content (including HTML), will not be
12082 # cached.
12083 #
12084 # If no value is provided for cdnPolicy.cacheMode, it defaults
12085 # to CACHE_ALL_STATIC.
12086 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
12087 # used to clamp the max-age (or Expires) value sent to the client. With
12088 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
12089 # response max-age directive, along with a &quot;public&quot; directive. For
12090 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
12091 # from the origin (if specified), or else sets the response max-age
12092 # directive to the lesser of the client_ttl and default_ttl, and also
12093 # ensures a &quot;public&quot; cache-control directive is present.
12094 # If a client TTL is not specified, a default value (1 hour) will be used.
12095 # The maximum allowed value is 31,622,400s (1 year).
12096 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
12097 # responses that do not have an existing valid TTL (max-age or s-maxage).
12098 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
12099 # The value of defaultTTL cannot be set to a value greater than that of
12100 # maxTTL, but can be equal.
12101 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
12102 # will overwrite the TTL set in all responses. The maximum allowed value is
12103 # 31,622,400s (1 year), noting that infrequently accessed objects may be
12104 # evicted from the cache before the defined TTL.
12105 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
12106 # origin.
12107 # Cache directives that attempt to set a max-age or s-maxage higher than
12108 # this, or an Expires header more than maxTTL seconds in the future will
12109 # be capped at the value of maxTTL, as if it were the value of an
12110 # s-maxage Cache-Control directive.
12111 # Headers sent to the client will not be modified.
12112 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
12113 # The maximum allowed value is 31,622,400s (1 year), noting that
12114 # infrequently accessed objects may be evicted from the cache before
12115 # the defined TTL.
12116 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
12117 # to apply fine-grained caching for common errors or redirects.
12118 # This can reduce the load on your origin and improve end-user
12119 # experience by reducing response latency.
12120 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
12121 # negative caching applies to responses with the specified response code
12122 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
12123 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
12124 # to all responses with the specified response code, and override any
12125 # caching headers.
12126 # By default, Cloud CDN will apply the following default TTLs to these
12127 # status codes:
12128 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
12129 # HTTP 404 (Not Found), 410 (Gone),
12130 # 451 (Unavailable For Legal Reasons): 120s
12131 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
12132 # These defaults can be overridden in negative_caching_policy.
12133 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
12134 # negative_caching must be enabled to configure negative_caching_policy.
12135 # Omitting the policy and leaving negative_caching enabled will use
12136 # Cloud CDN&#x27;s default cache TTLs.
12137 # Note that when specifying an explicit negative_caching_policy, you
12138 # should take care to specify a cache TTL for all response codes
12139 # that you wish to cache. Cloud CDN will not apply any default
12140 # negative caching when a policy exists.
12141 { # Specify CDN TTLs for response error codes.
12142 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
12143 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
12144 # specified as values, and you cannot specify a status code more than
12145 # once.
12146 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
12147 # corresponding status code.
12148 # The maximum allowed value is 1800s (30 minutes), noting that
12149 # infrequently accessed objects may be evicted from the cache before the
12150 # defined TTL.
12151 },
12152 ],
12153 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
12154 # requests into a small number of requests to the origin.
12155 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
12156 # content with the origin, or when an error is encountered when refreshing
12157 # the cache.
12158 # This setting defines the default &quot;max-stale&quot; duration for any cached
12159 # responses that do not specify a max-stale directive. Stale responses that
12160 # exceed the TTL configured here will not be served. The default limit
12161 # (max-stale) is 86400s (1 day), which will allow stale content to be
12162 # served up to this limit beyond the max-age (or s-maxage) of a cached
12163 # response.
12164 # The maximum allowed value is 604800 (1 week).
12165 # Set this to zero (0) to disable serve-while-stale.
12166 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
12167 # considered fresh. After this time period, the response will be
12168 # revalidated before being served. Defaults to 1hr (3600s). When serving
12169 # responses to signed URL requests, Cloud CDN will internally behave as
12170 # though all responses from this backend had a &quot;Cache-Control:
12171 # public, max-age=[TTL]&quot; header, regardless of any existing
12172 # Cache-Control header. The actual headers served in responses will not be
12173 # altered.
12174 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
12175 &quot;A String&quot;,
12176 ],
12177 },
12178 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
12179 # backend service.
12180 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
12181 # as a count of seconds and fractions of seconds at nanosecond
12182 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12183 # or &quot;month&quot;. Range is approximately 10,000 years.
12184 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12185 # Durations less than one second are represented with a 0
12186 # `seconds` field and a positive `nanos` field. Must be from 0
12187 # to 999,999,999 inclusive.
12188 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12189 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12190 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12191 },
12192 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
12193 # there is no limit.
12194 #
12195 # Not supported when the backend service is referenced by a URL map that is
12196 # bound to target gRPC proxy that has validateForProxyless field set to true.
12197 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
12198 # not specified, there is no limit.
12199 #
12200 # Not supported when the backend service is referenced by a URL map that is
12201 # bound to target gRPC proxy that has validateForProxyless field set to true.
12202 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
12203 # service. If not specified, there is no limit.
12204 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
12205 # This parameter is respected by both the HTTP/1.1 and HTTP/2
12206 # implementations. If not specified, there is no limit. Setting this
12207 # parameter to 1 will effectively disable keep alive.
12208 #
12209 # Not supported when the backend service is referenced by a URL map that is
12210 # bound to target gRPC proxy that has validateForProxyless field set to true.
12211 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
12212 # not specified, the default is 1.
12213 #
12214 # Not supported when the backend service is referenced by a URL map that is
12215 # bound to target gRPC proxy that has validateForProxyless field set to true.
12216 },
12217 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
12218 # the client&#x27;s Accept-Encoding header.
12219 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
12220 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
12221 # instance. For supported load balancers and protocols, as described inEnabling
12222 # connection draining.
12223 },
12224 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
12225 # tracking policy settings are only available for external passthrough
12226 # Network Load Balancers and internal passthrough Network Load Balancers.
12227 #
12228 # connectionTrackingPolicy cannot be specified with haPolicy.
12229 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
12230 # value is DEFAULT_FOR_PROTOCOL.
12231 #
12232 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
12233 # persist on unhealthy backends only for connection-oriented protocols
12234 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
12235 # Affinity is configured for 5-tuple. They do not persist forUDP.
12236 #
12237 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
12238 # the existing connections on the unhealthy backend are never persisted on
12239 # the unhealthy backend. They are always diverted to newly selected healthy
12240 # backends (unless all backends are unhealthy).
12241 #
12242 # If set to ALWAYS_PERSIST, existing connections always
12243 # persist on unhealthy backends regardless of protocol and session
12244 # affinity. It is generally not recommended to use this mode overriding the
12245 # default.
12246 #
12247 # For more details, see [Connection Persistence for Network Load
12248 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
12249 # and [Connection Persistence for Internal TCP/UDP Load
12250 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
12251 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
12252 # Balancers. This option is not available publicly.
12253 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
12254 # matching traffic (in seconds).
12255 #
12256 # For internal passthrough Network Load Balancers:
12257 #
12258 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
12259 # - It can be set only if Connection Tracking is less than 5-tuple
12260 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
12261 # Mode is PER_SESSION).
12262 #
12263 #
12264 #
12265 # For external passthrough Network Load Balancers the default is 60
12266 # seconds. This option is not available publicly.
12267 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
12268 # options:
12269 #
12270 # - PER_CONNECTION: This is the default mode. The Connection
12271 # Tracking is performed as per the Connection Key (default Hash Method) for
12272 # the specific protocol.
12273 # - PER_SESSION: The Connection Tracking is performed as per
12274 # the configured Session Affinity. It matches the configured Session
12275 # Affinity.
12276 #
12277 #
12278 #
12279 # For more details, see [Tracking Mode for Network Load
12280 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
12281 # and [Tracking Mode for Internal TCP/UDP Load
12282 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
12283 },
12284 &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
12285 # affinity based on HTTP headers, cookies or other properties. This load
12286 # balancing policy is applicable only for HTTP connections. The affinity to a
12287 # particular destination host will be lost when one or more hosts are
12288 # added/removed from the destination service. This field specifies parameters
12289 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
12290 #
12291 # This field is applicable to either:
12292 #
12293 # - A regional backend service with the service protocol set to HTTP,
12294 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
12295 # INTERNAL_MANAGED.
12296 # - A global backend service with the
12297 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
12298 &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
12299 # be used as the hash key for the consistent hash load balancer. If the
12300 # cookie is not present, it will be generated. This field is applicable if
12301 # the sessionAffinity is set to HTTP_COOKIE.
12302 #
12303 # Not supported when the backend service is referenced by a URL map that is
12304 # bound to target gRPC proxy that has validateForProxyless field set to true.
12305 # for load balancing policies that use a consistent hash.
12306 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
12307 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
12308 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
12309 # as a count of seconds and fractions of seconds at nanosecond
12310 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12311 # or &quot;month&quot;. Range is approximately 10,000 years.
12312 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12313 # Durations less than one second are represented with a 0
12314 # `seconds` field and a positive `nanos` field. Must be from 0
12315 # to 999,999,999 inclusive.
12316 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12317 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12318 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12319 },
12320 },
12321 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
12322 # applicable if the sessionAffinity is set toHEADER_FIELD.
12323 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
12324 # 1024. Larger ring sizes result in more granular load distributions. If the
12325 # number of hosts in the load balancing pool is larger than the ring size,
12326 # each host will be assigned a single virtual node.
12327 },
12328 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
12329 # text format.
12330 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
12331 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
12332 # locality_lb_policy.
12333 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
12334 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
12335 # long and match the regular expression
12336 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
12337 # first character must be a lowercase letter, and all following
12338 # characters must be a dash, period, underscore, lowercase letter, or
12339 # digit, except the last character, which cannot be a dash, period, or
12340 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
12341 # field can only be used for a global or regional backend service with the
12342 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
12343 },
12344 ],
12345 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
12346 # custom
12347 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
12348 &quot;A String&quot;,
12349 ],
12350 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
12351 # custom
12352 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
12353 &quot;A String&quot;,
12354 ],
12355 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
12356 # create the resource.
12357 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
12358 # backend service with dynamic forwarding feature which together with Service
12359 # Extension allows customized and complex routing logic.
12360 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
12361 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
12362 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
12363 },
12364 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
12365 # service. Some ranges are restricted: Restricted
12366 # ranges.
12367 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
12368 },
12369 },
12370 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
12371 # this backend service.
12372 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
12373 # global external Application Load Balancer.
12374 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
12375 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
12376 #
12377 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
12378 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
12379 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
12380 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
12381 # externalManagedMigrationTestingPercentage.
12382 #
12383 # Rolling back a migration requires the states to be set in reverse order. So
12384 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
12385 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
12386 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
12387 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
12388 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
12389 # external Application Load Balancer.
12390 #
12391 # The value of this field must be in the range [0, 100].
12392 #
12393 # Session affinity options will slightly affect this routing behavior, for
12394 # more details, see:Session
12395 # Affinity.
12396 #
12397 # This value can only be set if the loadBalancingScheme in the BackendService
12398 # is set to EXTERNAL (when using the classic Application Load Balancer) and
12399 # the migration state is TEST_BY_PERCENTAGE.
12400 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
12401 # as a backup (failover) backend.
12402 # For load balancers that have configurable failover:
12403 # [Internal passthrough Network Load
12404 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12405 # and [external passthrough Network Load
12406 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12407 #
12408 # failoverPolicy cannot be specified with haPolicy.
12409 # failover:
12410 # [Internal passthrough Network Load
12411 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12412 # and [external passthrough
12413 # Network Load
12414 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12415 # On failover or failback, this field indicates whether connection draining
12416 # will be honored. Google Cloud has a fixed connection draining timeout of
12417 # 10 minutes. A setting of true terminates existing TCP
12418 # connections to the active pool during failover and failback, immediately
12419 # draining traffic. A setting of false allows existing TCP
12420 # connections to persist, even on VMs no longer in the active pool, for up
12421 # to the duration of the connection draining timeout (10 minutes).
12422 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
12423 #
12424 # The default is false.
12425 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
12426 # load balancer are dropped when all primary and all backup backend VMs are
12427 # unhealthy.If set to false, connections are distributed
12428 # among all primary VMs when all primary and all backup backend VMs are
12429 # unhealthy.
12430 # For load balancers that have configurable
12431 # failover:
12432 # [Internal passthrough
12433 # Network Load
12434 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12435 # and [external passthrough
12436 # Network Load
12437 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12438 # The default is false.
12439 &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
12440 # failover when the number of healthy primary VMs equals zero.
12441 # For all other values, the load balancer performs a failover when the
12442 # total number of healthy primary VMs is less than this ratio.
12443 # For load balancers that have configurable
12444 # failover:
12445 # [Internal TCP/UDP Load
12446 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12447 # and [external TCP/UDP Load
12448 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12449 },
12450 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
12451 # This field is used in optimistic locking. This field will be ignored when
12452 # inserting a BackendService. An up-to-date fingerprint must be provided in
12453 # order to update the BackendService, otherwise the request will
12454 # fail with error 412 conditionNotMet.
12455 #
12456 # To see the latest fingerprint, make a get() request to
12457 # retrieve a BackendService.
12458 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
12459 # Protocol Forwarding.
12460 #
12461 # The backends of this regional backend service must only specify zonal
12462 # network endpoint groups (NEGs) of type GCE_VM_IP.
12463 #
12464 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
12465 # regional backend service must set the network field. All zonal NEGs must
12466 # belong to the same network. However, individual NEGs can
12467 # belong to different subnetworks of that network.
12468 #
12469 # When haPolicy is specified, the set of attached network endpoints across
12470 # all backends comprise an High Availability domain from which one endpoint
12471 # is selected as the active endpoint (the leader) that receives all
12472 # traffic.
12473 #
12474 # haPolicy can be added only at backend service creation time. Once set up,
12475 # it cannot be deleted.
12476 #
12477 # Note that haPolicy is not for load balancing, and therefore cannot be
12478 # specified with sessionAffinity, connectionTrackingPolicy, and
12479 # failoverPolicy.
12480 #
12481 # haPolicy requires customers to be responsible for tracking backend
12482 # endpoint health and electing a leader among the healthy endpoints.
12483 # Therefore, haPolicy cannot be specified with healthChecks.
12484 #
12485 # haPolicy can only be specified for External Passthrough Network Load
12486 # Balancers and Internal Passthrough Network Load Balancers.
12487 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
12488 # achieve it.
12489 #
12490 # Supported values are:
12491 #
12492 # - DISABLED: Fast IP Move is disabled. You can only use the
12493 # haPolicy.leader API to update the leader.
12494 # - &gt;GARP_RA: Provides a method to very quickly define a new network
12495 # endpoint as the leader. This method is faster than updating the leader
12496 # using the haPolicy.leader API. Fast IP move works as follows: The VM
12497 # hosting the network endpoint that should become the new leader sends
12498 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
12499 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
12500 # temporarily associates the forwarding rule IP address with that VM, and
12501 # both new and in-flight packets are quickly delivered to that VM.
12502 #
12503 #
12504 #
12505 # Note the important properties of the Fast IP Move functionality:
12506 #
12507 # - The GARP/RA-initiated re-routing stays active for approximately 20
12508 # minutes. After triggering fast failover, you must also
12509 # appropriately set the haPolicy.leader.
12510 # - The new leader instance should continue to send GARP/RA packets
12511 # periodically every 10 seconds until at least 10 minutes after updating
12512 # the haPolicy.leader (but stop immediately if it is no longer the leader).
12513 # - After triggering a fast failover, we recommend that you wait at least
12514 # 3 seconds before sending another GARP/RA packet from a different VM
12515 # instance to avoid race conditions.
12516 # - Don&#x27;t send GARP/RA packets from different VM
12517 # instances at the same time. If multiple instances continue to send
12518 # GARP/RA packets, traffic might be routed to different destinations in an
12519 # alternating order. This condition ceases when a single instance
12520 # issues a GARP/RA packet.
12521 # - The GARP/RA request always takes priority over the leader API.
12522 # Using the haPolicy.leader API to change the leader to a different
12523 # instance will have no effect until the GARP/RA request becomes
12524 # inactive.
12525 # - The GARP/RA packets should follow the GARP/RA
12526 # Packet Specifications..
12527 # - When multiple forwarding rules refer to a regional backend service,
12528 # you need only send a GARP or RA packet for a single forwarding rule
12529 # virtual IP. The virtual IPs for all forwarding rules targeting the same
12530 # backend service will also be moved to the sender of the GARP or RA
12531 # packet.
12532 #
12533 #
12534 #
12535 # The following are the Fast IP Move limitations (that is, when fastIPMove
12536 # is not DISABLED):
12537 #
12538 # - Multiple forwarding rules cannot use the same IP address if one of
12539 # them refers to a regional backend service with fastIPMove.
12540 # - The regional backend service must set the network field, and all
12541 # NEGs must belong to that network. However, individual
12542 # NEGs can belong to different subnetworks of that network.
12543 # - The maximum number of network endpoints across all backends of a
12544 # backend service with fastIPMove is 32.
12545 # - The maximum number of backend services with fastIPMove that can have
12546 # the same network endpoint attached to one of its backends is 64.
12547 # - The maximum number of backend services with fastIPMove in a VPC in a
12548 # region is 64.
12549 # - The network endpoints that are attached to a backend of a backend
12550 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
12551 # - Traffic directed to the leader by a static route next hop will not be
12552 # redirected to a new leader by fast failover. Such traffic will only be
12553 # redirected once an haPolicy.leader update has taken effect. Only traffic
12554 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
12555 # fast failover.
12556 #
12557 #
12558 # haPolicy.fastIPMove can be set only at backend service creation time.
12559 # Once set, it cannot be updated.
12560 #
12561 # By default, fastIpMove is set to DISABLED.
12562 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
12563 # this service as the active endpoint (the leader) that receives all
12564 # traffic.
12565 #
12566 # When the leader changes, there is no connection draining to persist
12567 # existing connections on the old leader.
12568 #
12569 # You are responsible for selecting a suitable endpoint as the
12570 # leader. For example, preferring a healthy endpoint over unhealthy ones.
12571 # Note that this service does not track backend endpoint health, and
12572 # selects the configured leader unconditionally.
12573 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
12574 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
12575 # that the leader is attached to.
12576 #
12577 # The leader&#x27;s backendGroup must already be specified as a backend of
12578 # this backend service. Removing a backend that is designated as the
12579 # leader&#x27;s backendGroup is not permitted.
12580 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
12581 # designated as the leader.
12582 #
12583 # This network endpoint cannot be detached from the NEG specified in
12584 # the haPolicy.leader.backendGroup until the leader is updated with
12585 # another network endpoint, or the leader is removed from the haPolicy.
12586 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
12587 # instance must already be attached to the NEG specified in the
12588 # haPolicy.leader.backendGroup.
12589 #
12590 # The name must be 1-63 characters long, and comply with RFC1035.
12591 # Authorization requires the following IAM permission on the
12592 # specified resource instance: compute.instances.use
12593 },
12594 },
12595 },
12596 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
12597 # httpsHealthChecks (legacy) resource for health checking this backend
12598 # service. Not all backend services support legacy health checks. See
12599 # Load balancer guide. Currently, at most one health check can be
12600 # specified for each backend service. Backend services with
12601 # instance group or zonal NEG backends must have a health check unless
12602 # haPolicy is specified. Backend services with internet or serverless NEG
12603 # backends must not have a health check.
12604 #
12605 # healthChecks[] cannot be specified with haPolicy.
12606 &quot;A String&quot;,
12607 ],
12608 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
12609 # Not available for internal passthrough Network Load Balancers and external
12610 # passthrough Network Load Balancers.
12611 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
12612 # incoming requests.
12613 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
12614 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
12615 # for IAP.
12616 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
12617 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
12618 # Optional - If not provided, the name will be autogenerated by the
12619 # backend.
12620 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
12621 },
12622 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
12623 # For security reasons, this value cannot be retrieved via the API.
12624 # Instead, the SHA-256 hash of the value is returned in the
12625 # oauth2ClientSecretSha256 field.
12626 #
12627 # @InputOnly
12628 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
12629 },
12630 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
12631 # defined by the server.
12632 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
12633 # from the client to the backend for proxyless gRPC).
12634 # The possible values are:
12635 #
12636 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
12637 # backend service (Instance Group, Managed Instance Group, Network Endpoint
12638 # Group), regardless of traffic from the client to the proxy. Only IPv4
12639 # health checks are used to check the health of the backends. This is the
12640 # default setting.
12641 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
12642 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
12643 # address).
12644 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
12645 # backend service (Instance Group, Managed Instance Group, Network Endpoint
12646 # Group), regardless of traffic from the client to the proxy. Only IPv6
12647 # health checks are used to check the health of the backends.
12648 #
12649 #
12650 #
12651 # This field is applicable to either:
12652 #
12653 # - Advanced global external Application Load Balancer (load balancing
12654 # scheme EXTERNAL_MANAGED),
12655 # - Regional external Application Load
12656 # Balancer,
12657 # - Internal proxy Network Load Balancer (load balancing
12658 # scheme INTERNAL_MANAGED),
12659 # - Regional internal Application Load
12660 # Balancer (load balancing scheme INTERNAL_MANAGED),
12661 # - Traffic
12662 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
12663 # INTERNAL_SELF_MANAGED).
12664 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
12665 # for backend services.
12666 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
12667 # created for one type of load balancer cannot be used with another.
12668 # For more information, refer toChoosing
12669 # a load balancer.
12670 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
12671 # preference. When you use localityLbPolicies, you must set at least one
12672 # value for either the localityLbPolicies[].policy or the
12673 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
12674 # value set in the localityLbPolicy field.
12675 #
12676 # For an example of how to use this field, seeDefine
12677 # a list of preferred policies.
12678 #
12679 # Caution: This field and its children are intended for use in a service mesh
12680 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
12681 # that have this configuration.
12682 { # Container for either a built-in LB policy supported by gRPC or Envoy or
12683 # a custom one implemented by the end user.
12684 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
12685 # deployed with the client.
12686 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
12687 # by a locally installed custom policy implementation.
12688 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
12689 #
12690 # The value should match the name of a custom implementation registered
12691 # on the gRPC clients. It should follow protocol buffer message naming
12692 # conventions and include the full path (for example,
12693 # myorg.CustomLbPolicy). The maximum length is 256 characters.
12694 #
12695 # Do not specify the same custom policy more than once for a
12696 # backend. If you do, the configuration is rejected.
12697 #
12698 # For an example of how to use this field, seeUse
12699 # a custom policy.
12700 },
12701 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
12702 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
12703 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
12704 # about these values, see the description of localityLbPolicy.
12705 #
12706 # Do not specify the same policy more than once for a
12707 # backend. If you do, the configuration is rejected.
12708 },
12709 },
12710 ],
12711 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
12712 # possible values are:
12713 #
12714 # - ROUND_ROBIN: This is a simple policy in which each healthy
12715 # backend is selected in round robin order. This is the default.
12716 # - LEAST_REQUEST: An O(1) algorithm which
12717 # selects two random healthy hosts and picks the host which has fewer active
12718 # requests.
12719 # - RING_HASH: The ring/modulo hash load balancer implements
12720 # consistent hashing to backends. The algorithm has the property that the
12721 # addition/removal of a host from a set of N hosts only affects 1/N of the
12722 # requests.
12723 # - RANDOM: The load balancer selects a random healthy
12724 # host.
12725 # - ORIGINAL_DESTINATION: Backend host is selected
12726 # based on the client connection metadata, i.e., connections are opened to
12727 # the same address as the destination address of the incoming connection
12728 # before the connection was redirected to the load balancer.
12729 # - MAGLEV: used as a drop in replacement for the ring hash
12730 # load balancer. Maglev is not as stable as ring hash but has faster table
12731 # lookup build times and host selection times. For more information about
12732 # Maglev, see Maglev:
12733 # A Fast and Reliable Software Network Load Balancer.
12734 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
12735 # Load Balancing using weights computed from Backend reported Custom Metrics.
12736 # If set, the Backend Service responses are expected to contain non-standard
12737 # HTTP response header field Endpoint-Load-Metrics. The reported
12738 # metrics to use for computing the weights are specified via thecustomMetrics field.
12739 #
12740 # This field is applicable to either:
12741 # - A regional backend service with the service protocol set to HTTP,
12742 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
12743 # INTERNAL_MANAGED.
12744 # - A global backend service with the
12745 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
12746 # EXTERNAL_MANAGED.
12747 #
12748 #
12749 # If sessionAffinity is not configured—that is, if session
12750 # affinity remains at the default value of NONE—then the
12751 # default value for localityLbPolicy
12752 # is ROUND_ROBIN. If session affinity is set to a value other
12753 # than NONE,
12754 # then the default value for localityLbPolicy isMAGLEV.
12755 #
12756 # Only ROUND_ROBIN and RING_HASH are supported
12757 # when the backend service is referenced by a URL map that is bound to
12758 # target gRPC proxy that has validateForProxyless field set to true.
12759 #
12760 # localityLbPolicy cannot be specified with haPolicy.
12761 &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
12762 # by this backend service. If logging is enabled, logs will be exported to
12763 # Stackdriver.
12764 # backend service.
12765 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
12766 # traffic served by this backend service. The default value is false.
12767 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
12768 { # Determines which HTTP headers will be logged to Stackdriver.
12769 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
12770 },
12771 ],
12772 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
12773 { # Determines which HTTP headers will be logged to Stackdriver.
12774 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
12775 },
12776 ],
12777 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
12778 # This field can only be specified if logging is enabled for this backend
12779 # service. Configures whether all, none or a subset of optional fields
12780 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
12781 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
12782 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
12783 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
12784 # of optional fields you want to include in the logs. For example:
12785 # serverInstance, serverGkeDetails.cluster,
12786 # serverGkeDetails.pod.podNamespace
12787 &quot;A String&quot;,
12788 ],
12789 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
12790 # service. Configures whether all, none or a subset of optional fields
12791 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
12792 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
12793 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
12794 # service. The value of the field must be in [0, 1]. This configures the
12795 # sampling rate of requests to the load balancer where 1.0 means all logged
12796 # requests are reported and 0.0 means no logged requests are reported. The
12797 # default value is 1.0.
12798 },
12799 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
12800 # service. Duration is computed from the beginning of the stream until the
12801 # response has been completely processed, including all retries. A stream
12802 # that does not complete in this duration is closed.
12803 #
12804 # If not specified, there will be no timeout limit, i.e. the maximum
12805 # duration is infinite.
12806 #
12807 # This value can be overridden in the PathMatcher configuration of the
12808 # UrlMap that references this backend service.
12809 #
12810 # This field is only allowed when the loadBalancingScheme of
12811 # the backend service is INTERNAL_SELF_MANAGED.
12812 # as a count of seconds and fractions of seconds at nanosecond
12813 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12814 # or &quot;month&quot;. Range is approximately 10,000 years.
12815 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12816 # Durations less than one second are represented with a 0
12817 # `seconds` field and a positive `nanos` field. Must be from 0
12818 # to 999,999,999 inclusive.
12819 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12820 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12821 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12822 },
12823 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
12824 # controller and read by the backend RCTH
12825 &quot;a_key&quot;: &quot;A String&quot;,
12826 },
12827 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
12828 # The name must be 1-63 characters long, and comply withRFC1035.
12829 # Specifically, the name must be 1-63 characters long and match the regular
12830 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
12831 # character must be a lowercase letter, and all following characters must
12832 # be a dash, lowercase letter, or digit, except the last character, which
12833 # cannot be a dash.
12834 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
12835 #
12836 # This field must be set for Internal Passthrough Network Load Balancers when
12837 # the haPolicy is enabled, and for External Passthrough Network Load
12838 # Balancers when the haPolicy fastIpMove is enabled.
12839 #
12840 # 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.
12841 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
12842 # Load Balancers.
12843 #
12844 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
12845 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
12846 # endpoints in the local zone.
12847 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
12848 # possible values are:
12849 #
12850 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
12851 # is disabled. The load balancer distributes new connections to all
12852 # healthy backend endpoints across all zones.
12853 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
12854 # enabled. The load balancer distributes new connections to all healthy
12855 # backend endpoints in the local zone only. If there are no healthy
12856 # backend endpoints in the local zone, the load balancer distributes
12857 # new connections to all backend endpoints in the local zone.
12858 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
12859 # enabled. The load balancer distributes new connections to all healthy
12860 # backend endpoints in the local zone only. If there aren&#x27;t enough
12861 # healthy backend endpoints in the local zone, the load balancer
12862 # distributes new connections to all healthy backend endpoints across all
12863 # zones.
12864 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
12865 # of healthy backend endpoints in a zone to the count of backend
12866 # endpoints in that same zone is equal to or above this threshold, the
12867 # load balancer distributes new connections to all healthy endpoints in
12868 # the local zone only. When the ratio of the count of healthy backend
12869 # endpoints in a zone to the count of backend endpoints in that same
12870 # zone is below this threshold, the load balancer distributes all new
12871 # connections to all healthy endpoints across all zones.
12872 },
12873 },
12874 &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.
12875 # the backend service.
12876 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
12877 # service.
12878 },
12879 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
12880 # load balancing pool of each individual proxy instance that processes the
12881 # traffic for the given backend service. If not set, this feature is
12882 # considered disabled.
12883 #
12884 # Results of the outlier detection algorithm (ejection of endpoints from the
12885 # load balancing pool and returning them back to the pool) are executed
12886 # independently by each proxy instance of the load balancer. In most cases,
12887 # more than one proxy instance handles the traffic received by a backend
12888 # service. Thus, it is possible that an unhealthy endpoint is detected and
12889 # ejected by only some of the proxies, and while this happens, other proxies
12890 # may continue to send requests to the same unhealthy endpoint until they
12891 # detect and eject the unhealthy endpoint.
12892 #
12893 # Applicable backend endpoints can be:
12894 #
12895 # - VM instances in an Instance Group
12896 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
12897 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
12898 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
12899 # Functions Services
12900 # - Private Service Connect NEGs, that resolve to
12901 # Google-managed regional API endpoints or managed services published using
12902 # Private Service Connect
12903 #
12904 #
12905 #
12906 # Applicable backend service types can be:
12907 #
12908 # - A global backend service with the loadBalancingScheme set to
12909 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
12910 # - A regional backend
12911 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
12912 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
12913 # supported for Serverless NEGs.
12914 #
12915 #
12916 #
12917 # Not supported when the backend service is referenced by a URL map that is
12918 # bound to target gRPC proxy that has validateForProxyless field set to true.
12919 # pool for the backend service.
12920 &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
12921 # or 30s.
12922 #
12923 # After a backend endpoint is returned back to the load balancing pool, it
12924 # can be ejected again in another ejection analysis. Thus, the total ejection
12925 # time is equal to the base ejection time multiplied by the number of times
12926 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
12927 # as a count of seconds and fractions of seconds at nanosecond
12928 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12929 # or &quot;month&quot;. Range is approximately 10,000 years.
12930 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12931 # Durations less than one second are represented with a 0
12932 # `seconds` field and a positive `nanos` field. Must be from 0
12933 # to 999,999,999 inclusive.
12934 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12935 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12936 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12937 },
12938 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
12939 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
12940 # return code qualifies as an error. Defaults to 5.
12941 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
12942 # connection errors that are mapped to one of those status codes) before a
12943 # consecutive gateway failure ejection occurs. Defaults to 3.
12944 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12945 # outlier status is detected through consecutive 5xx. This setting can be
12946 # used to disable ejection or to ramp it up slowly. Defaults to 0.
12947 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12948 # outlier status is detected through consecutive gateway failures. This
12949 # setting can be used to disable ejection or to ramp it up slowly. Defaults
12950 # to 100.
12951 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12952 # outlier status is detected through success rate statistics. This setting
12953 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
12954 #
12955 # Not supported when the backend service uses Serverless NEG.
12956 &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
12957 # ejections and backend endpoints being returned to service. The interval is
12958 # equal to the number of seconds as defined in
12959 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
12960 # in outlierDetection.interval.nanos. Defaults to 1 second.
12961 # as a count of seconds and fractions of seconds at nanosecond
12962 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12963 # or &quot;month&quot;. Range is approximately 10,000 years.
12964 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12965 # Durations less than one second are represented with a 0
12966 # `seconds` field and a positive `nanos` field. Must be from 0
12967 # to 999,999,999 inclusive.
12968 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12969 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12970 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12971 },
12972 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
12973 # backend service that can be ejected if the ejection conditions are met.
12974 # Defaults to 50%.
12975 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
12976 # enough request volume to detect success rate outliers. If the number of
12977 # backend endpoints is fewer than this setting, outlier detection via success
12978 # rate statistics is not performed for any backend endpoint in the load
12979 # balancing pool. Defaults to 5.
12980 #
12981 # Not supported when the backend service uses Serverless NEG.
12982 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
12983 # (as defined by the interval duration above) to include this backend
12984 # endpoint in success rate based outlier detection. If the volume is lower
12985 # than this setting, outlier detection via success rate statistics is not
12986 # performed for that backend endpoint. Defaults to 100.
12987 #
12988 # Not supported when the backend service uses Serverless NEG.
12989 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
12990 # outlier ejection. The ejection threshold is the difference between the mean
12991 # success rate, and the product of this factor and the standard deviation of
12992 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
12993 # is divided by a thousand to get a double. That is, if the desired factor
12994 # is 1.9, the runtime value should be 1900. Defaults to 1900.
12995 #
12996 # Not supported when the backend service uses Serverless NEG.
12997 },
12998 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
12999 # as part of resource payload.
13000 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
13001 # Tag keys and values have the same definition as resource
13002 # manager tags. The field is allowed for INSERT
13003 # only. The keys/values to set on the resource should be specified in
13004 # either ID { : } or Namespaced format
13005 # { : }.
13006 # For example the following are valid inputs:
13007 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
13008 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
13009 # Note:
13010 # * Invalid combinations of ID &amp; namespaced format is not supported. For
13011 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
13012 &quot;a_key&quot;: &quot;A String&quot;,
13013 },
13014 },
13015 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
13016 # the backend. The default value is 80.
13017 # For internal passthrough Network Load Balancers and external passthrough
13018 # Network Load Balancers, omit port.
13019 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
13020 # communication to the backend VMs in that group. The
13021 # named port must be [defined on each backend instance
13022 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
13023 # This parameter has no meaning if the backends are NEGs. For internal
13024 # passthrough Network Load Balancers and external passthrough Network Load
13025 # Balancers, omit port_name.
13026 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
13027 # with backends.
13028 #
13029 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
13030 # depending on the chosen load balancer or Traffic Director configuration.
13031 # Refer to the documentation for the load balancers or for Traffic Director
13032 # for more information.
13033 #
13034 # Must be set to GRPC when the backend service is referenced by a URL map
13035 # that is bound to target gRPC proxy.
13036 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
13037 # resides. This field is not applicable to global backend services.
13038 # You must specify this field as part of the HTTP request URL. It is
13039 # not settable as a field in the request body.
13040 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
13041 # backend service.
13042 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
13043 # service. This field is applicable to a global backend service with the
13044 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
13045 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
13046 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
13047 # be accepted on backends, and if authenticated, which method/certificate
13048 # will set the request principal.
13049 # request principal.
13050 # The authentication settings for the backend service.
13051 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
13052 # Similar to peers, these will be evaluated in order the first valid one
13053 # will be used to set origin identity. If none of these methods pass, the
13054 # request will be rejected with authentication failed error (401). Leave the
13055 # list empty if origin authentication is not required.
13056 { # [Deprecated] Configuration for the origin authentication method.
13057 # Configuration for the origin authentication method.
13058 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
13059 # JWT configuration for origin authentication.
13060 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
13061 # will be accepted if audiences is empty.
13062 # Examples: bookstore_android.apps.googleusercontent.com,
13063 # bookstore_web.apps.googleusercontent.com
13064 &quot;A String&quot;,
13065 ],
13066 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
13067 # email address.
13068 # Examples: https://securetoken.google.com,
13069 # [email protected]
13070 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
13071 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
13072 # request. If no explicit location is specified, the following default
13073 # locations are tried in order:
13074 #
13075 # 1. The Authorization header using the Bearer schema. See `here
13076 # `_. Example:
13077 #
13078 # Authorization: Bearer .
13079 #
13080 # 2. `access_token` query parameter. See `this
13081 # `_
13082 #
13083 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
13084 # from the locations its issuer specified or from the default locations.
13085 #
13086 # This field is set if JWT is sent in a request header. This field specifies
13087 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
13088 # header format will be x-goog-iap-jwt-assertion: .
13089 { # [Deprecated] This message specifies a header location to extract JWT token.
13090 # This message specifies a header location to extract JWT token.
13091 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
13092 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
13093 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
13094 # with a space at the end.
13095 },
13096 ],
13097 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
13098 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
13099 # JWT format in the query parameter is /path?jwt_token=.
13100 &quot;A String&quot;,
13101 ],
13102 },
13103 },
13104 ],
13105 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
13106 # They will be evaluated in order the first valid one will be used to set
13107 # peer identity. If none of these methods pass, the request will be rejected
13108 # with authentication failed error (401). Leave the list empty if peer
13109 # authentication is not required.
13110 { # [Deprecated] Configuration for the peer authentication method.
13111 # Configuration for the peer authentication method.
13112 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
13113 # Configuration for the mutual Tls mode for peer authentication.
13114 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
13115 # field can be set to one of the following:
13116 # STRICT: Client certificate must be presented, connection is in TLS.
13117 # PERMISSIVE: Client certificate can be omitted, connection can be either
13118 # plaintext or TLS.
13119 },
13120 },
13121 ],
13122 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
13123 # Default value is USE_PEER. If peer (or origin) identity is not available,
13124 # either because peer/origin authentication is not defined, or failed,
13125 # principal will be left unset. In other words, binding rule does not affect
13126 # the decision to accept or reject request. This field can be set to one of
13127 # the following:
13128 # USE_PEER: Principal will be set to the identity from peer authentication.
13129 # USE_ORIGIN: Principal will be set to the identity from origin
13130 # authentication.
13131 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
13132 # identity information.
13133 # The TLS settings for the client or server.
13134 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
13135 # certificate.
13136 # Defines the mechanism to obtain the client or server certificate.
13137 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
13138 # applicable only if tlsCertificateSource is set to USE_PATH.
13139 # The paths to the mounted TLS Certificates and private key.
13140 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13141 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13142 },
13143 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13144 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13145 # is applicable only if tlsCertificateSource is set to USE_SDS.
13146 # The configuration to access the SDS server.
13147 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13148 # gRPC config to access the SDS server.
13149 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13150 # gRPC call credentials to access the SDS server.
13151 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13152 # This field can be set to one of the following:
13153 #
13154 # - GCE_VM: The local GCE VM service account credentials are used to access
13155 # the SDS server.
13156 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13157 # SDS server.
13158 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13159 # FROM_PLUGIN.
13160 # Custom authenticator credentials.
13161 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13162 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13163 # plugin.
13164 },
13165 },
13166 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13167 # gRPC channel credentials to access the SDS server.
13168 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13169 # The paths to the mounted TLS Certificates and private key.
13170 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13171 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13172 },
13173 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13174 # to one of the following:
13175 # CERTIFICATES: Use TLS certificates to access the SDS server.
13176 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13177 },
13178 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13179 },
13180 },
13181 },
13182 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
13183 # validate the client/server certificate. If omitted, the proxy will not
13184 # validate the server or client certificate.
13185 # certificate to validate the client/server certificate.
13186 # validate the client/server certificate.
13187 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
13188 # client or server certificate.
13189 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13190 # is applicable only if tlsCertificateSource is set to USE_SDS.
13191 # The configuration to access the SDS server.
13192 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13193 # gRPC config to access the SDS server.
13194 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13195 # gRPC call credentials to access the SDS server.
13196 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13197 # This field can be set to one of the following:
13198 #
13199 # - GCE_VM: The local GCE VM service account credentials are used to access
13200 # the SDS server.
13201 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13202 # SDS server.
13203 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13204 # FROM_PLUGIN.
13205 # Custom authenticator credentials.
13206 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13207 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13208 # plugin.
13209 },
13210 },
13211 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13212 # gRPC channel credentials to access the SDS server.
13213 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13214 # The paths to the mounted TLS Certificates and private key.
13215 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13216 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13217 },
13218 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13219 # to one of the following:
13220 # CERTIFICATES: Use TLS certificates to access the SDS server.
13221 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13222 },
13223 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13224 },
13225 },
13226 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13227 },
13228 },
13229 },
13230 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
13231 # (RBAC) config.
13232 # Authorization config defines the Role Based Access Control (RBAC) config.
13233 # method-level access control for a service.
13234 # control for a service.
13235 &quot;policies&quot;: [ # List of RbacPolicies.
13236 {
13237 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
13238 &quot;permissions&quot;: [ # The list of permissions.
13239 { # [Deprecated] All fields defined in a permission are ANDed.
13240 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
13241 { # Custom constraint that specifies a key and a list of allowed values for
13242 # Istio attributes.
13243 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
13244 &quot;values&quot;: [ # A list of allowed values.
13245 &quot;A String&quot;,
13246 ],
13247 },
13248 ],
13249 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
13250 # applies to. Exact match, prefix match, and suffix match are supported.
13251 &quot;A String&quot;,
13252 ],
13253 &quot;methods&quot;: [ # HTTP method.
13254 &quot;A String&quot;,
13255 ],
13256 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
13257 &quot;A String&quot;,
13258 ],
13259 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
13260 &quot;A String&quot;,
13261 ],
13262 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
13263 &quot;A String&quot;,
13264 ],
13265 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
13266 &quot;A String&quot;,
13267 ],
13268 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
13269 # Exact match, prefix match, and suffix match are supported.
13270 &quot;A String&quot;,
13271 ],
13272 &quot;ports&quot;: [ # Port names or numbers.
13273 &quot;A String&quot;,
13274 ],
13275 },
13276 ],
13277 &quot;principals&quot;: [ # The list of principals.
13278 { # [Deprecated] All fields defined in a principal are ANDed.
13279 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
13280 &quot;groups&quot;: [ # The groups the principal belongs to.
13281 # Exact match, prefix match, and suffix match are supported.
13282 &quot;A String&quot;,
13283 ],
13284 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
13285 &quot;A String&quot;,
13286 ],
13287 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
13288 &quot;A String&quot;,
13289 ],
13290 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
13291 &quot;A String&quot;,
13292 ],
13293 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
13294 &quot;A String&quot;,
13295 ],
13296 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
13297 &quot;A String&quot;,
13298 ],
13299 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
13300 &quot;A String&quot;,
13301 ],
13302 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
13303 # suffix match are supported for values. For example,
13304 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
13305 &quot;a_key&quot;: &quot;A String&quot;,
13306 },
13307 &quot;users&quot;: [ # The user names/IDs or service accounts.
13308 # Exact match, prefix match, and suffix match are supported.
13309 &quot;A String&quot;,
13310 ],
13311 },
13312 ],
13313 },
13314 ],
13315 },
13316 &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
13317 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
13318 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
13319 # private storage buckets that support Signature Version 4 for authentication.
13320 # The service name for generating the authentication header will always default
13321 # to &#x27;s3&#x27;.
13322 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
13323 # creating a backend that uses AWS v4 signature authentication, but will not
13324 # be returned as part of the configuration when queried with a REST API GET
13325 # request.
13326 #
13327 # @InputOnly
13328 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
13329 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
13330 # keep track of different iterations of your access key.
13331 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
13332 # the name of the region your cloud uses to host your origin. For example,
13333 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
13334 },
13335 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
13336 # that describes how clients should authenticate with this service&#x27;s
13337 # backends.
13338 #
13339 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
13340 # to INTERNAL_SELF_MANAGED.
13341 #
13342 # If left blank, communications are not encrypted.
13343 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
13344 # originating from the backend service.
13345 # the backend service.
13346 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
13347 # identity information. This field is only applicable when mode is set to
13348 # MUTUAL.
13349 # The TLS settings for the client or server.
13350 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
13351 # certificate.
13352 # Defines the mechanism to obtain the client or server certificate.
13353 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
13354 # applicable only if tlsCertificateSource is set to USE_PATH.
13355 # The paths to the mounted TLS Certificates and private key.
13356 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13357 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13358 },
13359 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13360 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13361 # is applicable only if tlsCertificateSource is set to USE_SDS.
13362 # The configuration to access the SDS server.
13363 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13364 # gRPC config to access the SDS server.
13365 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13366 # gRPC call credentials to access the SDS server.
13367 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13368 # This field can be set to one of the following:
13369 #
13370 # - GCE_VM: The local GCE VM service account credentials are used to access
13371 # the SDS server.
13372 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13373 # SDS server.
13374 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13375 # FROM_PLUGIN.
13376 # Custom authenticator credentials.
13377 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13378 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13379 # plugin.
13380 },
13381 },
13382 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13383 # gRPC channel credentials to access the SDS server.
13384 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13385 # The paths to the mounted TLS Certificates and private key.
13386 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13387 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13388 },
13389 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13390 # to one of the following:
13391 # CERTIFICATES: Use TLS certificates to access the SDS server.
13392 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13393 },
13394 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13395 },
13396 },
13397 },
13398 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
13399 # validate the client/server certificate. If omitted, the proxy will not
13400 # validate the server or client certificate.
13401 # certificate to validate the client/server certificate.
13402 # validate the client/server certificate.
13403 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
13404 # client or server certificate.
13405 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
13406 # is applicable only if tlsCertificateSource is set to USE_SDS.
13407 # The configuration to access the SDS server.
13408 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
13409 # gRPC config to access the SDS server.
13410 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
13411 # gRPC call credentials to access the SDS server.
13412 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
13413 # This field can be set to one of the following:
13414 #
13415 # - GCE_VM: The local GCE VM service account credentials are used to access
13416 # the SDS server.
13417 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
13418 # SDS server.
13419 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
13420 # FROM_PLUGIN.
13421 # Custom authenticator credentials.
13422 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
13423 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
13424 # plugin.
13425 },
13426 },
13427 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
13428 # gRPC channel credentials to access the SDS server.
13429 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
13430 # The paths to the mounted TLS Certificates and private key.
13431 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
13432 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
13433 },
13434 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
13435 # to one of the following:
13436 # CERTIFICATES: Use TLS certificates to access the SDS server.
13437 # GCE_VM: Use local GCE VM credentials to access the SDS server.
13438 },
13439 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
13440 },
13441 },
13442 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
13443 },
13444 },
13445 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
13446 # The value of this field determines how TLS is enforced. This can be set
13447 # to one of the following values: DISABLE: Do not setup a TLS connection to
13448 # the backends.
13449 # SIMPLE: Originate a TLS connection to the backends.
13450 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
13451 # client certificates for authentication.
13452 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
13453 # applicable only when mode is SIMPLE or MUTUAL.
13454 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
13455 # certificate.If specified,
13456 # the proxy will verify that the server certificate&#x27;s subject alt name
13457 # matches one of the specified values. This field is applicable only when
13458 # mode is SIMPLE or MUTUAL.
13459 &quot;A String&quot;,
13460 ],
13461 },
13462 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
13463 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
13464 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
13465 # specified values, the communication continues. Otherwise, it fails. This
13466 # additional check enables the client to verify that the server is authorized
13467 # to run the requested service.
13468 #
13469 # Note that the contents of the server
13470 # certificate&#x27;s subjectAltName field are configured by the
13471 # Public Key Infrastructure which provisions server identities.
13472 #
13473 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
13474 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
13475 # mode).
13476 &quot;A String&quot;,
13477 ],
13478 },
13479 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13480 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
13481 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
13482 #
13483 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
13484 # If set, lists of backends and health checks must be both empty.
13485 &quot;A String&quot;,
13486 ],
13487 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
13488 #
13489 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
13490 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
13491 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
13492 #
13493 # Only NONE and HEADER_FIELD are supported
13494 # when the backend service is referenced by a URL map that is bound to
13495 # target gRPC proxy that has validateForProxyless field set to true.
13496 #
13497 # For more details, see:
13498 # [Session
13499 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
13500 #
13501 # sessionAffinity cannot be specified with haPolicy.
13502 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
13503 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
13504 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
13505 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
13506 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
13507 # as a count of seconds and fractions of seconds at nanosecond
13508 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13509 # or &quot;month&quot;. Range is approximately 10,000 years.
13510 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13511 # Durations less than one second are represented with a 0
13512 # `seconds` field and a positive `nanos` field. Must be from 0
13513 # to 999,999,999 inclusive.
13514 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13515 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13516 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13517 },
13518 },
13519 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
13520 # Currently this is applicable only for Internal TCP/UDP load balancing,
13521 # Internal HTTP(S) load balancing and Traffic Director.
13522 &quot;policy&quot;: &quot;A String&quot;,
13523 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
13524 # each service mesh client.
13525 #
13526 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
13527 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
13528 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
13529 # `INTERNAL_SELF_MANAGED`.
13530 #
13531 # `subset_size` is optional for Internal HTTP(S) load balancing
13532 # and required for Traffic Director.
13533 #
13534 # If you do not provide this value, Cloud Load Balancing will calculate it
13535 # dynamically to optimize the number of proxies/clients visible to each
13536 # backend and vice versa.
13537 #
13538 # Must be greater than 0. If `subset_size` is larger than the number of
13539 # backends/endpoints, then subsetting is disabled.
13540 },
13541 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
13542 # type of load balancer. For more information see,
13543 # Backend service settings.
13544 # The default is 30 seconds.
13545 # The full range of timeout values allowed goes from 1
13546 # through 2,147,483,647 seconds.
13547 #
13548 # This value can be overridden in the PathMatcher configuration of the
13549 # UrlMap that references this backend service.
13550 #
13551 # Not supported when the backend service is referenced by a URL map that is
13552 # bound to target gRPC proxy that has validateForProxyless field set to true.
13553 # Instead, use maxStreamDuration.
13554 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
13555 # when the backend protocol is SSL, HTTPS or HTTP2.
13556 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
13557 # networksecurity.googleapis.com namespace. Can be used in authenticating
13558 # TLS connections to the backend, as specified by the authenticationMode
13559 # field. Can only be specified if authenticationMode is not NONE.
13560 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
13561 #
13562 #
13563 # Use this property to configure the load balancer back-end to use
13564 # certificates and roots of trust provisioned by the Managed Workload
13565 # Identity system.
13566 #
13567 # The `identity` property is the
13568 # fully-specified SPIFFE ID to use in the SVID presented by the Load
13569 # Balancer Workload.
13570 #
13571 # The SPIFFE ID must be a resource starting with the
13572 # `trustDomain` property value, followed by the path to the Managed
13573 # Workload Identity.
13574 #
13575 # Supported SPIFFE ID format:
13576 #
13577 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
13578 #
13579 #
13580 # The Trust Domain within the Managed Identity must refer to a valid
13581 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
13582 # will be inherited from the Workload Identity Pool.
13583 #
13584 # Restrictions:
13585 #
13586 # - If you set the `identity` property, you cannot manually set
13587 # the following fields:
13588 # - tlsSettings.sni
13589 # - tlsSettings.subjectAltNames
13590 # - tlsSettings.authenticationConfig
13591 #
13592 #
13593 # When defining a `identity` for a RegionBackendServices, the
13594 # corresponding Workload Identity Pool must have a ca_pool
13595 # configured in the same region.
13596 #
13597 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
13598 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
13599 # balancer sends this string as the SNI hostname in the TLS connection to
13600 # the backend, and requires that this string match a Subject Alternative
13601 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
13602 # NEG backend, if the SNI is specified here, the load balancer uses it
13603 # regardless of whether the Regional Internet NEG is specified with FQDN or
13604 # IP address and port. When both sni and subjectAltNames[] are specified,
13605 # the load balancer matches the backend certificate&#x27;s SAN only to
13606 # subjectAltNames[].
13607 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
13608 # verifies during a TLS handshake with the backend. When the server
13609 # presents its X.509 certificate to the Load Balancer, the Load Balancer
13610 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
13611 # match one of the subjectAltNames in the list. This field is limited to 5
13612 # entries. When both sni and subjectAltNames[] are specified, the load
13613 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
13614 { # A Subject Alternative Name that the load balancer matches against the SAN
13615 # field in the TLS certificate provided by the backend, specified as either
13616 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
13617 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
13618 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
13619 },
13620 ],
13621 },
13622 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
13623 {
13624 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
13625 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
13626 # and ForwardingRule.
13627 },
13628 ],
13629 }
13630
13631 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13632 that if you must retry your request, the server will know to ignore the
13633 request if it has already been completed.
13634
13635 For example, consider a situation where you make an initial request and
13636 the request times out. If you make the request again with the same
13637 request ID, the server can check if original operation with the same
13638 request ID was received, and if so, will ignore the second request. This
13639 prevents clients from accidentally creating duplicate commitments.
13640
13641 The request ID must be
13642 a valid UUID with the exception that zero UUID is not supported
13643 (00000000-0000-0000-0000-000000000000).
13644 x__xgafv: string, V1 error format.
13645 Allowed values
13646 1 - v1 error format
13647 2 - v2 error format
13648
13649 Returns:
13650 An object of the form:
13651
13652 { # Represents an Operation resource.
13653 #
13654 # Google Compute Engine has three Operation resources:
13655 #
13656 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
13657 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
13658 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
13659 #
13660 # You can use an operation resource to manage asynchronous API requests.
13661 # For more information, readHandling
13662 # API responses.
13663 #
13664 # Operations can be global, regional or zonal.
13665 #
13666 # - For global operations, use the `globalOperations`
13667 # resource.
13668 # - For regional operations, use the
13669 # `regionOperations` resource.
13670 # - For zonal operations, use
13671 # the `zoneOperations` resource.
13672 #
13673 #
13674 #
13675 # For more information, read
13676 # Global, Regional, and Zonal Resources.
13677 #
13678 # Note that completed Operation resources have a limited
13679 # retention period.
13680 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13681 # Not present otherwise.
13682 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13683 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13684 # set when the operation is created.
13685 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13686 # text format.
13687 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13688 # this field will be populated.
13689 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13690 # operation.
13691 {
13692 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13693 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13694 # details. There is a set of defined message types to use for providing
13695 # details.The syntax depends on the error code. For example,
13696 # QuotaExceededInfo will have details when the error code is
13697 # QUOTA_EXCEEDED.
13698 {
13699 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13700 #
13701 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13702 # is not enabled:
13703 #
13704 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13705 # &quot;domain&quot;: &quot;googleapis.com&quot;
13706 # &quot;metadata&quot;: {
13707 # &quot;resource&quot;: &quot;projects/123&quot;,
13708 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13709 # }
13710 # }
13711 #
13712 # This response indicates that the pubsub.googleapis.com API is not enabled.
13713 #
13714 # Example of an error that is returned when attempting to create a Spanner
13715 # instance in a region that is out of stock:
13716 #
13717 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13718 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13719 # &quot;metadata&quot;: {
13720 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13721 # }
13722 # }
13723 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13724 # is typically the registered service name of the tool or product that
13725 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13726 # generated by some common infrastructure, the error domain must be a
13727 # globally unique value that identifies the infrastructure. For Google API
13728 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13729 &quot;metadatas&quot;: { # Additional structured details about this error.
13730 #
13731 # Keys must match a regular expression of `a-z+` but should
13732 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13733 # length. When identifying the current value of an exceeded limit, the units
13734 # should be contained in the key, not the value. For example, rather than
13735 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13736 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13737 # instances that can be created in a single (batch) request.
13738 &quot;a_key&quot;: &quot;A String&quot;,
13739 },
13740 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13741 # proximate cause of the error. Error reasons are unique within a particular
13742 # domain of errors. This should be at most 63 characters and match a
13743 # regular expression of `A-Z+[A-Z0-9]`, which represents
13744 # UPPER_SNAKE_CASE.
13745 },
13746 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13747 #
13748 # For example, if a quota check failed with an error indicating the calling
13749 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13750 # directly to the right place in the developer console to flip the bit.
13751 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13752 { # Describes a URL link.
13753 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13754 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13755 },
13756 ],
13757 },
13758 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13759 # which can be attached to an RPC error.
13760 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13761 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13762 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13763 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13764 },
13765 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13766 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13767 &quot;a_key&quot;: &quot;A String&quot;,
13768 },
13769 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13770 # type or metric.
13771 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13772 # or metric.
13773 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13774 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13775 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13776 },
13777 },
13778 ],
13779 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13780 # This property is optional.
13781 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13782 },
13783 ],
13784 },
13785 &quot;getVersionOperationMetadata&quot;: {
13786 &quot;inlineSbomInfo&quot;: {
13787 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13788 # appropriate identifiers.
13789 &quot;a_key&quot;: &quot;A String&quot;,
13790 },
13791 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13792 # identifiers.
13793 &quot;a_key&quot;: &quot;A String&quot;,
13794 },
13795 },
13796 },
13797 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13798 # message that was returned, such as `NOT FOUND`.
13799 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13800 # status code that was returned. For example, a `404` means the
13801 # resource was not found.
13802 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13803 # defined by the server.
13804 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13805 # This value is inRFC3339
13806 # text format.
13807 &quot;instancesBulkInsertOperationMetadata&quot;: {
13808 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13809 # Example key: zones/us-central1-a
13810 &quot;a_key&quot;: {
13811 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13812 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13813 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13814 # error.
13815 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13816 # if the flow is rolling forward or rolling back.
13817 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13818 },
13819 },
13820 },
13821 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13822 # Operation resources.
13823 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13824 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13825 # group of operations results from a `bulkInsert` API request.
13826 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13827 # `update`, or `delete`, and so on.
13828 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13829 # There is no requirement that this be linear or support any granularity of
13830 # operations. This should not be used to guess when the operation will be
13831 # complete. This number should monotonically increase as the operation
13832 # progresses.
13833 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13834 # applicable when performing regional operations.
13835 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13836 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
13837 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13838 # this field will contain information on all underlying zonal actions and
13839 # their state.
13840 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13841 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13842 # Example key: zones/us-central1-a
13843 &quot;a_key&quot;: {
13844 &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
13845 # populated.
13846 # different programming environments, including REST APIs and RPC APIs. It is
13847 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13848 # three pieces of data: error code, error message, and error details.
13849 #
13850 # You can find out more about this error model and how to work with it in the
13851 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13852 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13853 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13854 # message types for APIs to use.
13855 {
13856 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13857 },
13858 ],
13859 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13860 # user-facing error message should be localized and sent in the
13861 # google.rpc.Status.details field, or localized by the client.
13862 },
13863 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13864 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13865 },
13866 },
13867 },
13868 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13869 # This value is inRFC3339
13870 # text format.
13871 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13872 # following:
13873 # `PENDING`, `RUNNING`, or `DONE`.
13874 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13875 # operation.
13876 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13877 # of the target resource.
13878 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13879 # operations related to creating a snapshot, this points to the disk
13880 # that the snapshot was created from.
13881 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13882 # `[email protected]` or
13883 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13884 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13885 # operation, this field will be populated.
13886 {
13887 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13888 # Engine returns NO_RESULTS_ON_PAGE if there
13889 # are no results in the response.
13890 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13891 # value format. For example:
13892 #
13893 # &quot;data&quot;: [
13894 # {
13895 # &quot;key&quot;: &quot;scope&quot;,
13896 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13897 # }
13898 {
13899 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13900 # returned. For example, for warnings where there are no results in a list
13901 # request for a particular zone, this key might be scope and
13902 # the key value might be the zone name. Other examples might be a key
13903 # indicating a deprecated resource and a suggested replacement, or a
13904 # warning about invalid network settings (for example, if an instance
13905 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13906 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13907 },
13908 ],
13909 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13910 },
13911 ],
13912 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13913 # applicable when performing per-zone operations.
13914 }</pre>
13915 </div>
13916
13917 <div class="method">
13918 <code class="details" id="setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
13919 <pre>Sets the edge security policy for the specified backend service.
13920
13921 Args:
13922 project: string, Project ID for this request. (required)
13923 backendService: string, Name of the BackendService resource to which the edge security policy
13924 should be set. The name should conform to RFC1035. (required)
13925 body: object, The request body.
13926 The object takes the form of:
13927
13928 {
13929 &quot;securityPolicy&quot;: &quot;A String&quot;,
13930 }
13931
13932 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13933 that if you must retry your request, the server will know to ignore the
13934 request if it has already been completed.
13935
13936 For example, consider a situation where you make an initial request and
13937 the request times out. If you make the request again with the same
13938 request ID, the server can check if original operation with the same
13939 request ID was received, and if so, will ignore the second request. This
13940 prevents clients from accidentally creating duplicate commitments.
13941
13942 The request ID must be
13943 a valid UUID with the exception that zero UUID is not supported
13944 (00000000-0000-0000-0000-000000000000).
13945 x__xgafv: string, V1 error format.
13946 Allowed values
13947 1 - v1 error format
13948 2 - v2 error format
13949
13950 Returns:
13951 An object of the form:
13952
13953 { # Represents an Operation resource.
13954 #
13955 # Google Compute Engine has three Operation resources:
13956 #
13957 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
13958 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
13959 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
13960 #
13961 # You can use an operation resource to manage asynchronous API requests.
13962 # For more information, readHandling
13963 # API responses.
13964 #
13965 # Operations can be global, regional or zonal.
13966 #
13967 # - For global operations, use the `globalOperations`
13968 # resource.
13969 # - For regional operations, use the
13970 # `regionOperations` resource.
13971 # - For zonal operations, use
13972 # the `zoneOperations` resource.
13973 #
13974 #
13975 #
13976 # For more information, read
13977 # Global, Regional, and Zonal Resources.
13978 #
13979 # Note that completed Operation resources have a limited
13980 # retention period.
13981 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13982 # Not present otherwise.
13983 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13984 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13985 # set when the operation is created.
13986 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13987 # text format.
13988 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13989 # this field will be populated.
13990 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13991 # operation.
13992 {
13993 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13994 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13995 # details. There is a set of defined message types to use for providing
13996 # details.The syntax depends on the error code. For example,
13997 # QuotaExceededInfo will have details when the error code is
13998 # QUOTA_EXCEEDED.
13999 {
14000 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14001 #
14002 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14003 # is not enabled:
14004 #
14005 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14006 # &quot;domain&quot;: &quot;googleapis.com&quot;
14007 # &quot;metadata&quot;: {
14008 # &quot;resource&quot;: &quot;projects/123&quot;,
14009 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14010 # }
14011 # }
14012 #
14013 # This response indicates that the pubsub.googleapis.com API is not enabled.
14014 #
14015 # Example of an error that is returned when attempting to create a Spanner
14016 # instance in a region that is out of stock:
14017 #
14018 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14019 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14020 # &quot;metadata&quot;: {
14021 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14022 # }
14023 # }
14024 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14025 # is typically the registered service name of the tool or product that
14026 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14027 # generated by some common infrastructure, the error domain must be a
14028 # globally unique value that identifies the infrastructure. For Google API
14029 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14030 &quot;metadatas&quot;: { # Additional structured details about this error.
14031 #
14032 # Keys must match a regular expression of `a-z+` but should
14033 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14034 # length. When identifying the current value of an exceeded limit, the units
14035 # should be contained in the key, not the value. For example, rather than
14036 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14037 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14038 # instances that can be created in a single (batch) request.
14039 &quot;a_key&quot;: &quot;A String&quot;,
14040 },
14041 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14042 # proximate cause of the error. Error reasons are unique within a particular
14043 # domain of errors. This should be at most 63 characters and match a
14044 # regular expression of `A-Z+[A-Z0-9]`, which represents
14045 # UPPER_SNAKE_CASE.
14046 },
14047 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14048 #
14049 # For example, if a quota check failed with an error indicating the calling
14050 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14051 # directly to the right place in the developer console to flip the bit.
14052 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14053 { # Describes a URL link.
14054 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14055 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14056 },
14057 ],
14058 },
14059 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14060 # which can be attached to an RPC error.
14061 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14062 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14063 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14064 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14065 },
14066 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14067 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14068 &quot;a_key&quot;: &quot;A String&quot;,
14069 },
14070 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14071 # type or metric.
14072 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14073 # or metric.
14074 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14075 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14076 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14077 },
14078 },
14079 ],
14080 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14081 # This property is optional.
14082 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14083 },
14084 ],
14085 },
14086 &quot;getVersionOperationMetadata&quot;: {
14087 &quot;inlineSbomInfo&quot;: {
14088 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14089 # appropriate identifiers.
14090 &quot;a_key&quot;: &quot;A String&quot;,
14091 },
14092 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14093 # identifiers.
14094 &quot;a_key&quot;: &quot;A String&quot;,
14095 },
14096 },
14097 },
14098 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14099 # message that was returned, such as `NOT FOUND`.
14100 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14101 # status code that was returned. For example, a `404` means the
14102 # resource was not found.
14103 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14104 # defined by the server.
14105 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14106 # This value is inRFC3339
14107 # text format.
14108 &quot;instancesBulkInsertOperationMetadata&quot;: {
14109 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14110 # Example key: zones/us-central1-a
14111 &quot;a_key&quot;: {
14112 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14113 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14114 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14115 # error.
14116 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14117 # if the flow is rolling forward or rolling back.
14118 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14119 },
14120 },
14121 },
14122 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14123 # Operation resources.
14124 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14125 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14126 # group of operations results from a `bulkInsert` API request.
14127 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14128 # `update`, or `delete`, and so on.
14129 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14130 # There is no requirement that this be linear or support any granularity of
14131 # operations. This should not be used to guess when the operation will be
14132 # complete. This number should monotonically increase as the operation
14133 # progresses.
14134 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14135 # applicable when performing regional operations.
14136 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14137 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
14138 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14139 # this field will contain information on all underlying zonal actions and
14140 # their state.
14141 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14142 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14143 # Example key: zones/us-central1-a
14144 &quot;a_key&quot;: {
14145 &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
14146 # populated.
14147 # different programming environments, including REST APIs and RPC APIs. It is
14148 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14149 # three pieces of data: error code, error message, and error details.
14150 #
14151 # You can find out more about this error model and how to work with it in the
14152 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14153 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14154 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14155 # message types for APIs to use.
14156 {
14157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14158 },
14159 ],
14160 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14161 # user-facing error message should be localized and sent in the
14162 # google.rpc.Status.details field, or localized by the client.
14163 },
14164 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14165 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14166 },
14167 },
14168 },
14169 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14170 # This value is inRFC3339
14171 # text format.
14172 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14173 # following:
14174 # `PENDING`, `RUNNING`, or `DONE`.
14175 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14176 # operation.
14177 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14178 # of the target resource.
14179 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14180 # operations related to creating a snapshot, this points to the disk
14181 # that the snapshot was created from.
14182 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14183 # `[email protected]` or
14184 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14185 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14186 # operation, this field will be populated.
14187 {
14188 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14189 # Engine returns NO_RESULTS_ON_PAGE if there
14190 # are no results in the response.
14191 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14192 # value format. For example:
14193 #
14194 # &quot;data&quot;: [
14195 # {
14196 # &quot;key&quot;: &quot;scope&quot;,
14197 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14198 # }
14199 {
14200 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14201 # returned. For example, for warnings where there are no results in a list
14202 # request for a particular zone, this key might be scope and
14203 # the key value might be the zone name. Other examples might be a key
14204 # indicating a deprecated resource and a suggested replacement, or a
14205 # warning about invalid network settings (for example, if an instance
14206 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14207 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14208 },
14209 ],
14210 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14211 },
14212 ],
14213 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14214 # applicable when performing per-zone operations.
14215 }</pre>
14216 </div>
14217
14218 <div class="method">
14219 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
14220 <pre>Sets the access control policy on the specified resource.
14221 Replaces any existing policy.
14222
14223 Args:
14224 project: string, Project ID for this request. (required)
14225 resource: string, Name or id of the resource for this request. (required)
14226 body: object, The request body.
14227 The object takes the form of:
14228
14229 {
14230 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
14231 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
14232 { # Associates `members`, or principals, with a `role`.
14233 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
14234 #
14235 # If the condition evaluates to `true`, then this binding applies to the
14236 # current request.
14237 #
14238 # If the condition evaluates to `false`, then this binding does not apply to
14239 # the current request. However, a different role binding might grant the same
14240 # role to one or more of the principals in this binding.
14241 #
14242 # To learn which resources support conditions in their IAM policies, see the
14243 # [IAM
14244 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14245 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
14246 # are documented at https://github.com/google/cel-spec.
14247 #
14248 # Example (Comparison):
14249 #
14250 # title: &quot;Summary size limit&quot;
14251 # description: &quot;Determines if a summary is less than 100 chars&quot;
14252 # expression: &quot;document.summary.size() &lt; 100&quot;
14253 #
14254 # Example (Equality):
14255 #
14256 # title: &quot;Requestor is owner&quot;
14257 # description: &quot;Determines if requestor is the document owner&quot;
14258 # expression: &quot;document.owner == request.auth.claims.email&quot;
14259 #
14260 # Example (Logic):
14261 #
14262 # title: &quot;Public documents&quot;
14263 # description: &quot;Determine whether the document should be publicly visible&quot;
14264 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
14265 #
14266 # Example (Data Manipulation):
14267 #
14268 # title: &quot;Notification string&quot;
14269 # description: &quot;Create a notification string with a timestamp.&quot;
14270 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
14271 #
14272 # The exact variables and functions that may be referenced within an expression
14273 # are determined by the service that evaluates it. See the service
14274 # documentation for additional information.
14275 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
14276 # describes the expression, e.g. when hovered over it in a UI.
14277 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
14278 # syntax.
14279 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
14280 # reporting, e.g. a file name and a position in the file.
14281 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
14282 # its purpose. This can be used e.g. in UIs which allow to enter the
14283 # expression.
14284 },
14285 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
14286 # `members` can have the following values:
14287 #
14288 # * `allUsers`: A special identifier that represents anyone who is
14289 # on the internet; with or without a Google account.
14290 #
14291 # * `allAuthenticatedUsers`: A special identifier that represents anyone
14292 # who is authenticated with a Google account or a service account.
14293 # Does not include identities that come from external identity providers
14294 # (IdPs) through identity federation.
14295 #
14296 # * `user:{emailid}`: An email address that represents a specific Google
14297 # account. For example, `[email protected]` .
14298 #
14299 #
14300 # * `serviceAccount:{emailid}`: An email address that represents a Google
14301 # service account. For example,
14302 # `[email protected]`.
14303 #
14304 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
14305 # identifier for a
14306 # [Kubernetes service
14307 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
14308 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
14309 #
14310 # * `group:{emailid}`: An email address that represents a Google group.
14311 # For example, `[email protected]`.
14312 #
14313 #
14314 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
14315 # users of that domain. For example, `google.com` or `example.com`.
14316 #
14317 #
14318 #
14319 #
14320 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14321 # A single identity in a workforce identity pool.
14322 #
14323 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
14324 # All workforce identities in a group.
14325 #
14326 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
14327 # All workforce identities with a specific attribute value.
14328 #
14329 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
14330 # All identities in a workforce identity pool.
14331 #
14332 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
14333 # A single identity in a workload identity pool.
14334 #
14335 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
14336 # A workload identity pool group.
14337 #
14338 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
14339 # All identities in a workload identity pool with a certain attribute.
14340 #
14341 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
14342 # All identities in a workload identity pool.
14343 #
14344 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
14345 # identifier) representing a user that has been recently deleted. For
14346 # example, `[email protected]?uid=123456789012345678901`. If the user is
14347 # recovered, this value reverts to `user:{emailid}` and the recovered user
14348 # retains the role in the binding.
14349 #
14350 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
14351 # unique identifier) representing a service account that has been recently
14352 # deleted. For example,
14353 # `[email protected]?uid=123456789012345678901`.
14354 # If the service account is undeleted, this value reverts to
14355 # `serviceAccount:{emailid}` and the undeleted service account retains the
14356 # role in the binding.
14357 #
14358 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
14359 # identifier) representing a Google group that has been recently
14360 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
14361 # the group is recovered, this value reverts to `group:{emailid}` and the
14362 # recovered group retains the role in the binding.
14363 #
14364 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14365 # Deleted single identity in a workforce identity pool. For example,
14366 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
14367 &quot;A String&quot;,
14368 ],
14369 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
14370 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
14371 #
14372 # For an overview of the IAM roles and permissions, see the
14373 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
14374 # a list of the available pre-defined roles, see
14375 # [here](https://cloud.google.com/iam/docs/understanding-roles).
14376 },
14377 ],
14378 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
14379 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
14380 &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
14381 # the policy is limited to a few 10s of KB. An empty policy is in general a
14382 # valid policy but certain services (like Projects) might reject them.
14383 # controls for Google Cloud resources.
14384 #
14385 #
14386 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
14387 # `members`, or principals, to a single `role`. Principals can be user
14388 # accounts, service accounts, Google groups, and domains (such as G Suite). A
14389 # `role` is a named list of permissions; each `role` can be an IAM predefined
14390 # role or a user-created custom role.
14391 #
14392 # For some types of Google Cloud resources, a `binding` can also specify a
14393 # `condition`, which is a logical expression that allows access to a resource
14394 # only if the expression evaluates to `true`. A condition can add constraints
14395 # based on attributes of the request, the resource, or both. To learn which
14396 # resources support conditions in their IAM policies, see the
14397 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14398 #
14399 # **JSON example:**
14400 #
14401 # ```
14402 # {
14403 # &quot;bindings&quot;: [
14404 # {
14405 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
14406 # &quot;members&quot;: [
14407 # &quot;user:[email protected]&quot;,
14408 # &quot;group:[email protected]&quot;,
14409 # &quot;domain:google.com&quot;,
14410 # &quot;serviceAccount:[email protected]&quot;
14411 # ]
14412 # },
14413 # {
14414 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
14415 # &quot;members&quot;: [
14416 # &quot;user:[email protected]&quot;
14417 # ],
14418 # &quot;condition&quot;: {
14419 # &quot;title&quot;: &quot;expirable access&quot;,
14420 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
14421 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
14422 # }
14423 # }
14424 # ],
14425 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
14426 # &quot;version&quot;: 3
14427 # }
14428 # ```
14429 #
14430 # **YAML example:**
14431 #
14432 # ```
14433 # bindings:
14434 # - members:
14435 # - user:[email protected]
14436 # - group:[email protected]
14437 # - domain:google.com
14438 # - serviceAccount:[email protected]
14439 # role: roles/resourcemanager.organizationAdmin
14440 # - members:
14441 # - user:[email protected]
14442 # role: roles/resourcemanager.organizationViewer
14443 # condition:
14444 # title: expirable access
14445 # description: Does not grant access after Sep 2020
14446 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
14447 # etag: BwWWja0YfJA=
14448 # version: 3
14449 # ```
14450 #
14451 # For a description of IAM and its features, see the
14452 # [IAM documentation](https://cloud.google.com/iam/docs/).
14453 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
14454 { # Specifies the audit configuration for a service.
14455 # The configuration determines which permission types are logged, and what
14456 # identities, if any, are exempted from logging.
14457 # An AuditConfig must have one or more AuditLogConfigs.
14458 #
14459 # If there are AuditConfigs for both `allServices` and a specific service,
14460 # the union of the two AuditConfigs is used for that service: the log_types
14461 # specified in each AuditConfig are enabled, and the exempted_members in each
14462 # AuditLogConfig are exempted.
14463 #
14464 # Example Policy with multiple AuditConfigs:
14465 #
14466 # {
14467 # &quot;audit_configs&quot;: [
14468 # {
14469 # &quot;service&quot;: &quot;allServices&quot;,
14470 # &quot;audit_log_configs&quot;: [
14471 # {
14472 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
14473 # &quot;exempted_members&quot;: [
14474 # &quot;user:[email protected]&quot;
14475 # ]
14476 # },
14477 # {
14478 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
14479 # },
14480 # {
14481 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
14482 # }
14483 # ]
14484 # },
14485 # {
14486 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
14487 # &quot;audit_log_configs&quot;: [
14488 # {
14489 # &quot;log_type&quot;: &quot;DATA_READ&quot;
14490 # },
14491 # {
14492 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
14493 # &quot;exempted_members&quot;: [
14494 # &quot;user:[email protected]&quot;
14495 # ]
14496 # }
14497 # ]
14498 # }
14499 # ]
14500 # }
14501 #
14502 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
14503 # logging. It also exempts `[email protected]` from DATA_READ logging, and
14504 # `[email protected]` from DATA_WRITE logging.
14505 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
14506 { # Provides the configuration for logging a type of permissions.
14507 # Example:
14508 #
14509 # {
14510 # &quot;audit_log_configs&quot;: [
14511 # {
14512 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
14513 # &quot;exempted_members&quot;: [
14514 # &quot;user:[email protected]&quot;
14515 # ]
14516 # },
14517 # {
14518 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
14519 # }
14520 # ]
14521 # }
14522 #
14523 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
14524 # [email protected] from DATA_READ logging.
14525 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
14526 # permission.
14527 # Follows the same format of Binding.members.
14528 &quot;A String&quot;,
14529 ],
14530 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
14531 },
14532 ],
14533 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
14534 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
14535 # `allServices` is a special value that covers all services.
14536 },
14537 ],
14538 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
14539 # may specify a `condition` that determines how and when the `bindings` are
14540 # applied. Each of the `bindings` must contain at least one principal.
14541 #
14542 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
14543 # of these principals can be Google groups. Each occurrence of a principal
14544 # counts towards these limits. For example, if the `bindings` grant 50
14545 # different roles to `user:[email protected]`, and not to any other
14546 # principal, then you can add another 1,450 principals to the `bindings` in
14547 # the `Policy`.
14548 { # Associates `members`, or principals, with a `role`.
14549 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
14550 #
14551 # If the condition evaluates to `true`, then this binding applies to the
14552 # current request.
14553 #
14554 # If the condition evaluates to `false`, then this binding does not apply to
14555 # the current request. However, a different role binding might grant the same
14556 # role to one or more of the principals in this binding.
14557 #
14558 # To learn which resources support conditions in their IAM policies, see the
14559 # [IAM
14560 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14561 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
14562 # are documented at https://github.com/google/cel-spec.
14563 #
14564 # Example (Comparison):
14565 #
14566 # title: &quot;Summary size limit&quot;
14567 # description: &quot;Determines if a summary is less than 100 chars&quot;
14568 # expression: &quot;document.summary.size() &lt; 100&quot;
14569 #
14570 # Example (Equality):
14571 #
14572 # title: &quot;Requestor is owner&quot;
14573 # description: &quot;Determines if requestor is the document owner&quot;
14574 # expression: &quot;document.owner == request.auth.claims.email&quot;
14575 #
14576 # Example (Logic):
14577 #
14578 # title: &quot;Public documents&quot;
14579 # description: &quot;Determine whether the document should be publicly visible&quot;
14580 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
14581 #
14582 # Example (Data Manipulation):
14583 #
14584 # title: &quot;Notification string&quot;
14585 # description: &quot;Create a notification string with a timestamp.&quot;
14586 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
14587 #
14588 # The exact variables and functions that may be referenced within an expression
14589 # are determined by the service that evaluates it. See the service
14590 # documentation for additional information.
14591 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
14592 # describes the expression, e.g. when hovered over it in a UI.
14593 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
14594 # syntax.
14595 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
14596 # reporting, e.g. a file name and a position in the file.
14597 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
14598 # its purpose. This can be used e.g. in UIs which allow to enter the
14599 # expression.
14600 },
14601 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
14602 # `members` can have the following values:
14603 #
14604 # * `allUsers`: A special identifier that represents anyone who is
14605 # on the internet; with or without a Google account.
14606 #
14607 # * `allAuthenticatedUsers`: A special identifier that represents anyone
14608 # who is authenticated with a Google account or a service account.
14609 # Does not include identities that come from external identity providers
14610 # (IdPs) through identity federation.
14611 #
14612 # * `user:{emailid}`: An email address that represents a specific Google
14613 # account. For example, `[email protected]` .
14614 #
14615 #
14616 # * `serviceAccount:{emailid}`: An email address that represents a Google
14617 # service account. For example,
14618 # `[email protected]`.
14619 #
14620 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
14621 # identifier for a
14622 # [Kubernetes service
14623 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
14624 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
14625 #
14626 # * `group:{emailid}`: An email address that represents a Google group.
14627 # For example, `[email protected]`.
14628 #
14629 #
14630 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
14631 # users of that domain. For example, `google.com` or `example.com`.
14632 #
14633 #
14634 #
14635 #
14636 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14637 # A single identity in a workforce identity pool.
14638 #
14639 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
14640 # All workforce identities in a group.
14641 #
14642 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
14643 # All workforce identities with a specific attribute value.
14644 #
14645 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
14646 # All identities in a workforce identity pool.
14647 #
14648 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
14649 # A single identity in a workload identity pool.
14650 #
14651 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
14652 # A workload identity pool group.
14653 #
14654 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
14655 # All identities in a workload identity pool with a certain attribute.
14656 #
14657 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
14658 # All identities in a workload identity pool.
14659 #
14660 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
14661 # identifier) representing a user that has been recently deleted. For
14662 # example, `[email protected]?uid=123456789012345678901`. If the user is
14663 # recovered, this value reverts to `user:{emailid}` and the recovered user
14664 # retains the role in the binding.
14665 #
14666 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
14667 # unique identifier) representing a service account that has been recently
14668 # deleted. For example,
14669 # `[email protected]?uid=123456789012345678901`.
14670 # If the service account is undeleted, this value reverts to
14671 # `serviceAccount:{emailid}` and the undeleted service account retains the
14672 # role in the binding.
14673 #
14674 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
14675 # identifier) representing a Google group that has been recently
14676 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
14677 # the group is recovered, this value reverts to `group:{emailid}` and the
14678 # recovered group retains the role in the binding.
14679 #
14680 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14681 # Deleted single identity in a workforce identity pool. For example,
14682 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
14683 &quot;A String&quot;,
14684 ],
14685 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
14686 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
14687 #
14688 # For an overview of the IAM roles and permissions, see the
14689 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
14690 # a list of the available pre-defined roles, see
14691 # [here](https://cloud.google.com/iam/docs/understanding-roles).
14692 },
14693 ],
14694 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
14695 # prevent simultaneous updates of a policy from overwriting each other.
14696 # It is strongly suggested that systems make use of the `etag` in the
14697 # read-modify-write cycle to perform policy updates in order to avoid race
14698 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
14699 # systems are expected to put that etag in the request to `setIamPolicy` to
14700 # ensure that their change will be applied to the same version of the policy.
14701 #
14702 # **Important:** If you use IAM Conditions, you must include the `etag` field
14703 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
14704 # you to overwrite a version `3` policy with a version `1` policy, and all of
14705 # the conditions in the version `3` policy are lost.
14706 &quot;version&quot;: 42, # Specifies the format of the policy.
14707 #
14708 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
14709 # are rejected.
14710 #
14711 # Any operation that affects conditional role bindings must specify version
14712 # `3`. This requirement applies to the following operations:
14713 #
14714 # * Getting a policy that includes a conditional role binding
14715 # * Adding a conditional role binding to a policy
14716 # * Changing a conditional role binding in a policy
14717 # * Removing any role binding, with or without a condition, from a policy
14718 # that includes conditions
14719 #
14720 # **Important:** If you use IAM Conditions, you must include the `etag` field
14721 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
14722 # you to overwrite a version `3` policy with a version `1` policy, and all of
14723 # the conditions in the version `3` policy are lost.
14724 #
14725 # If a policy does not include any conditions, operations on that policy may
14726 # specify any valid version or leave the field unset.
14727 #
14728 # To learn which resources support conditions in their IAM policies, see the
14729 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14730 },
14731 }
14732
14733 x__xgafv: string, V1 error format.
14734 Allowed values
14735 1 - v1 error format
14736 2 - v2 error format
14737
14738 Returns:
14739 An object of the form:
14740
14741 { # An Identity and Access Management (IAM) policy, which specifies access
14742 # controls for Google Cloud resources.
14743 #
14744 #
14745 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
14746 # `members`, or principals, to a single `role`. Principals can be user
14747 # accounts, service accounts, Google groups, and domains (such as G Suite). A
14748 # `role` is a named list of permissions; each `role` can be an IAM predefined
14749 # role or a user-created custom role.
14750 #
14751 # For some types of Google Cloud resources, a `binding` can also specify a
14752 # `condition`, which is a logical expression that allows access to a resource
14753 # only if the expression evaluates to `true`. A condition can add constraints
14754 # based on attributes of the request, the resource, or both. To learn which
14755 # resources support conditions in their IAM policies, see the
14756 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14757 #
14758 # **JSON example:**
14759 #
14760 # ```
14761 # {
14762 # &quot;bindings&quot;: [
14763 # {
14764 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
14765 # &quot;members&quot;: [
14766 # &quot;user:[email protected]&quot;,
14767 # &quot;group:[email protected]&quot;,
14768 # &quot;domain:google.com&quot;,
14769 # &quot;serviceAccount:[email protected]&quot;
14770 # ]
14771 # },
14772 # {
14773 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
14774 # &quot;members&quot;: [
14775 # &quot;user:[email protected]&quot;
14776 # ],
14777 # &quot;condition&quot;: {
14778 # &quot;title&quot;: &quot;expirable access&quot;,
14779 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
14780 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
14781 # }
14782 # }
14783 # ],
14784 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
14785 # &quot;version&quot;: 3
14786 # }
14787 # ```
14788 #
14789 # **YAML example:**
14790 #
14791 # ```
14792 # bindings:
14793 # - members:
14794 # - user:[email protected]
14795 # - group:[email protected]
14796 # - domain:google.com
14797 # - serviceAccount:[email protected]
14798 # role: roles/resourcemanager.organizationAdmin
14799 # - members:
14800 # - user:[email protected]
14801 # role: roles/resourcemanager.organizationViewer
14802 # condition:
14803 # title: expirable access
14804 # description: Does not grant access after Sep 2020
14805 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
14806 # etag: BwWWja0YfJA=
14807 # version: 3
14808 # ```
14809 #
14810 # For a description of IAM and its features, see the
14811 # [IAM documentation](https://cloud.google.com/iam/docs/).
14812 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
14813 { # Specifies the audit configuration for a service.
14814 # The configuration determines which permission types are logged, and what
14815 # identities, if any, are exempted from logging.
14816 # An AuditConfig must have one or more AuditLogConfigs.
14817 #
14818 # If there are AuditConfigs for both `allServices` and a specific service,
14819 # the union of the two AuditConfigs is used for that service: the log_types
14820 # specified in each AuditConfig are enabled, and the exempted_members in each
14821 # AuditLogConfig are exempted.
14822 #
14823 # Example Policy with multiple AuditConfigs:
14824 #
14825 # {
14826 # &quot;audit_configs&quot;: [
14827 # {
14828 # &quot;service&quot;: &quot;allServices&quot;,
14829 # &quot;audit_log_configs&quot;: [
14830 # {
14831 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
14832 # &quot;exempted_members&quot;: [
14833 # &quot;user:[email protected]&quot;
14834 # ]
14835 # },
14836 # {
14837 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
14838 # },
14839 # {
14840 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
14841 # }
14842 # ]
14843 # },
14844 # {
14845 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
14846 # &quot;audit_log_configs&quot;: [
14847 # {
14848 # &quot;log_type&quot;: &quot;DATA_READ&quot;
14849 # },
14850 # {
14851 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
14852 # &quot;exempted_members&quot;: [
14853 # &quot;user:[email protected]&quot;
14854 # ]
14855 # }
14856 # ]
14857 # }
14858 # ]
14859 # }
14860 #
14861 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
14862 # logging. It also exempts `[email protected]` from DATA_READ logging, and
14863 # `[email protected]` from DATA_WRITE logging.
14864 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
14865 { # Provides the configuration for logging a type of permissions.
14866 # Example:
14867 #
14868 # {
14869 # &quot;audit_log_configs&quot;: [
14870 # {
14871 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
14872 # &quot;exempted_members&quot;: [
14873 # &quot;user:[email protected]&quot;
14874 # ]
14875 # },
14876 # {
14877 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
14878 # }
14879 # ]
14880 # }
14881 #
14882 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
14883 # [email protected] from DATA_READ logging.
14884 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
14885 # permission.
14886 # Follows the same format of Binding.members.
14887 &quot;A String&quot;,
14888 ],
14889 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
14890 },
14891 ],
14892 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
14893 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
14894 # `allServices` is a special value that covers all services.
14895 },
14896 ],
14897 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
14898 # may specify a `condition` that determines how and when the `bindings` are
14899 # applied. Each of the `bindings` must contain at least one principal.
14900 #
14901 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
14902 # of these principals can be Google groups. Each occurrence of a principal
14903 # counts towards these limits. For example, if the `bindings` grant 50
14904 # different roles to `user:[email protected]`, and not to any other
14905 # principal, then you can add another 1,450 principals to the `bindings` in
14906 # the `Policy`.
14907 { # Associates `members`, or principals, with a `role`.
14908 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
14909 #
14910 # If the condition evaluates to `true`, then this binding applies to the
14911 # current request.
14912 #
14913 # If the condition evaluates to `false`, then this binding does not apply to
14914 # the current request. However, a different role binding might grant the same
14915 # role to one or more of the principals in this binding.
14916 #
14917 # To learn which resources support conditions in their IAM policies, see the
14918 # [IAM
14919 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14920 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
14921 # are documented at https://github.com/google/cel-spec.
14922 #
14923 # Example (Comparison):
14924 #
14925 # title: &quot;Summary size limit&quot;
14926 # description: &quot;Determines if a summary is less than 100 chars&quot;
14927 # expression: &quot;document.summary.size() &lt; 100&quot;
14928 #
14929 # Example (Equality):
14930 #
14931 # title: &quot;Requestor is owner&quot;
14932 # description: &quot;Determines if requestor is the document owner&quot;
14933 # expression: &quot;document.owner == request.auth.claims.email&quot;
14934 #
14935 # Example (Logic):
14936 #
14937 # title: &quot;Public documents&quot;
14938 # description: &quot;Determine whether the document should be publicly visible&quot;
14939 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
14940 #
14941 # Example (Data Manipulation):
14942 #
14943 # title: &quot;Notification string&quot;
14944 # description: &quot;Create a notification string with a timestamp.&quot;
14945 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
14946 #
14947 # The exact variables and functions that may be referenced within an expression
14948 # are determined by the service that evaluates it. See the service
14949 # documentation for additional information.
14950 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
14951 # describes the expression, e.g. when hovered over it in a UI.
14952 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
14953 # syntax.
14954 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
14955 # reporting, e.g. a file name and a position in the file.
14956 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
14957 # its purpose. This can be used e.g. in UIs which allow to enter the
14958 # expression.
14959 },
14960 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
14961 # `members` can have the following values:
14962 #
14963 # * `allUsers`: A special identifier that represents anyone who is
14964 # on the internet; with or without a Google account.
14965 #
14966 # * `allAuthenticatedUsers`: A special identifier that represents anyone
14967 # who is authenticated with a Google account or a service account.
14968 # Does not include identities that come from external identity providers
14969 # (IdPs) through identity federation.
14970 #
14971 # * `user:{emailid}`: An email address that represents a specific Google
14972 # account. For example, `[email protected]` .
14973 #
14974 #
14975 # * `serviceAccount:{emailid}`: An email address that represents a Google
14976 # service account. For example,
14977 # `[email protected]`.
14978 #
14979 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
14980 # identifier for a
14981 # [Kubernetes service
14982 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
14983 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
14984 #
14985 # * `group:{emailid}`: An email address that represents a Google group.
14986 # For example, `[email protected]`.
14987 #
14988 #
14989 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
14990 # users of that domain. For example, `google.com` or `example.com`.
14991 #
14992 #
14993 #
14994 #
14995 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14996 # A single identity in a workforce identity pool.
14997 #
14998 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
14999 # All workforce identities in a group.
15000 #
15001 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
15002 # All workforce identities with a specific attribute value.
15003 #
15004 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
15005 # All identities in a workforce identity pool.
15006 #
15007 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
15008 # A single identity in a workload identity pool.
15009 #
15010 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
15011 # A workload identity pool group.
15012 #
15013 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
15014 # All identities in a workload identity pool with a certain attribute.
15015 #
15016 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
15017 # All identities in a workload identity pool.
15018 #
15019 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
15020 # identifier) representing a user that has been recently deleted. For
15021 # example, `[email protected]?uid=123456789012345678901`. If the user is
15022 # recovered, this value reverts to `user:{emailid}` and the recovered user
15023 # retains the role in the binding.
15024 #
15025 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
15026 # unique identifier) representing a service account that has been recently
15027 # deleted. For example,
15028 # `[email protected]?uid=123456789012345678901`.
15029 # If the service account is undeleted, this value reverts to
15030 # `serviceAccount:{emailid}` and the undeleted service account retains the
15031 # role in the binding.
15032 #
15033 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
15034 # identifier) representing a Google group that has been recently
15035 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
15036 # the group is recovered, this value reverts to `group:{emailid}` and the
15037 # recovered group retains the role in the binding.
15038 #
15039 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
15040 # Deleted single identity in a workforce identity pool. For example,
15041 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
15042 &quot;A String&quot;,
15043 ],
15044 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
15045 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
15046 #
15047 # For an overview of the IAM roles and permissions, see the
15048 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
15049 # a list of the available pre-defined roles, see
15050 # [here](https://cloud.google.com/iam/docs/understanding-roles).
15051 },
15052 ],
15053 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
15054 # prevent simultaneous updates of a policy from overwriting each other.
15055 # It is strongly suggested that systems make use of the `etag` in the
15056 # read-modify-write cycle to perform policy updates in order to avoid race
15057 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
15058 # systems are expected to put that etag in the request to `setIamPolicy` to
15059 # ensure that their change will be applied to the same version of the policy.
15060 #
15061 # **Important:** If you use IAM Conditions, you must include the `etag` field
15062 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
15063 # you to overwrite a version `3` policy with a version `1` policy, and all of
15064 # the conditions in the version `3` policy are lost.
15065 &quot;version&quot;: 42, # Specifies the format of the policy.
15066 #
15067 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
15068 # are rejected.
15069 #
15070 # Any operation that affects conditional role bindings must specify version
15071 # `3`. This requirement applies to the following operations:
15072 #
15073 # * Getting a policy that includes a conditional role binding
15074 # * Adding a conditional role binding to a policy
15075 # * Changing a conditional role binding in a policy
15076 # * Removing any role binding, with or without a condition, from a policy
15077 # that includes conditions
15078 #
15079 # **Important:** If you use IAM Conditions, you must include the `etag` field
15080 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
15081 # you to overwrite a version `3` policy with a version `1` policy, and all of
15082 # the conditions in the version `3` policy are lost.
15083 #
15084 # If a policy does not include any conditions, operations on that policy may
15085 # specify any valid version or leave the field unset.
15086 #
15087 # To learn which resources support conditions in their IAM policies, see the
15088 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
15089 }</pre>
15090 </div>
15091
15092 <div class="method">
15093 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
15094 <pre>Sets the Google Cloud Armor security policy for the specified backend
15095 service. For more information, seeGoogle
15096 Cloud Armor Overview
15097
15098 Args:
15099 project: string, Project ID for this request. (required)
15100 backendService: string, Name of the BackendService resource to which the security policy should be
15101 set. The name should conform to RFC1035. (required)
15102 body: object, The request body.
15103 The object takes the form of:
15104
15105 {
15106 &quot;securityPolicy&quot;: &quot;A String&quot;,
15107 }
15108
15109 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15110 that if you must retry your request, the server will know to ignore the
15111 request if it has already been completed.
15112
15113 For example, consider a situation where you make an initial request and
15114 the request times out. If you make the request again with the same
15115 request ID, the server can check if original operation with the same
15116 request ID was received, and if so, will ignore the second request. This
15117 prevents clients from accidentally creating duplicate commitments.
15118
15119 The request ID must be
15120 a valid UUID with the exception that zero UUID is not supported
15121 (00000000-0000-0000-0000-000000000000).
15122 x__xgafv: string, V1 error format.
15123 Allowed values
15124 1 - v1 error format
15125 2 - v2 error format
15126
15127 Returns:
15128 An object of the form:
15129
15130 { # Represents an Operation resource.
15131 #
15132 # Google Compute Engine has three Operation resources:
15133 #
15134 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
15135 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
15136 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
15137 #
15138 # You can use an operation resource to manage asynchronous API requests.
15139 # For more information, readHandling
15140 # API responses.
15141 #
15142 # Operations can be global, regional or zonal.
15143 #
15144 # - For global operations, use the `globalOperations`
15145 # resource.
15146 # - For regional operations, use the
15147 # `regionOperations` resource.
15148 # - For zonal operations, use
15149 # the `zoneOperations` resource.
15150 #
15151 #
15152 #
15153 # For more information, read
15154 # Global, Regional, and Zonal Resources.
15155 #
15156 # Note that completed Operation resources have a limited
15157 # retention period.
15158 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15159 # Not present otherwise.
15160 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15161 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15162 # set when the operation is created.
15163 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15164 # text format.
15165 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15166 # this field will be populated.
15167 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15168 # operation.
15169 {
15170 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15171 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15172 # details. There is a set of defined message types to use for providing
15173 # details.The syntax depends on the error code. For example,
15174 # QuotaExceededInfo will have details when the error code is
15175 # QUOTA_EXCEEDED.
15176 {
15177 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15178 #
15179 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15180 # is not enabled:
15181 #
15182 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15183 # &quot;domain&quot;: &quot;googleapis.com&quot;
15184 # &quot;metadata&quot;: {
15185 # &quot;resource&quot;: &quot;projects/123&quot;,
15186 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15187 # }
15188 # }
15189 #
15190 # This response indicates that the pubsub.googleapis.com API is not enabled.
15191 #
15192 # Example of an error that is returned when attempting to create a Spanner
15193 # instance in a region that is out of stock:
15194 #
15195 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15196 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15197 # &quot;metadata&quot;: {
15198 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15199 # }
15200 # }
15201 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15202 # is typically the registered service name of the tool or product that
15203 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15204 # generated by some common infrastructure, the error domain must be a
15205 # globally unique value that identifies the infrastructure. For Google API
15206 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15207 &quot;metadatas&quot;: { # Additional structured details about this error.
15208 #
15209 # Keys must match a regular expression of `a-z+` but should
15210 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15211 # length. When identifying the current value of an exceeded limit, the units
15212 # should be contained in the key, not the value. For example, rather than
15213 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15214 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15215 # instances that can be created in a single (batch) request.
15216 &quot;a_key&quot;: &quot;A String&quot;,
15217 },
15218 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15219 # proximate cause of the error. Error reasons are unique within a particular
15220 # domain of errors. This should be at most 63 characters and match a
15221 # regular expression of `A-Z+[A-Z0-9]`, which represents
15222 # UPPER_SNAKE_CASE.
15223 },
15224 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15225 #
15226 # For example, if a quota check failed with an error indicating the calling
15227 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15228 # directly to the right place in the developer console to flip the bit.
15229 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15230 { # Describes a URL link.
15231 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15232 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15233 },
15234 ],
15235 },
15236 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15237 # which can be attached to an RPC error.
15238 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15239 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15240 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15241 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15242 },
15243 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15244 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15245 &quot;a_key&quot;: &quot;A String&quot;,
15246 },
15247 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15248 # type or metric.
15249 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15250 # or metric.
15251 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15252 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15253 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15254 },
15255 },
15256 ],
15257 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15258 # This property is optional.
15259 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15260 },
15261 ],
15262 },
15263 &quot;getVersionOperationMetadata&quot;: {
15264 &quot;inlineSbomInfo&quot;: {
15265 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15266 # appropriate identifiers.
15267 &quot;a_key&quot;: &quot;A String&quot;,
15268 },
15269 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15270 # identifiers.
15271 &quot;a_key&quot;: &quot;A String&quot;,
15272 },
15273 },
15274 },
15275 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15276 # message that was returned, such as `NOT FOUND`.
15277 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15278 # status code that was returned. For example, a `404` means the
15279 # resource was not found.
15280 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15281 # defined by the server.
15282 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15283 # This value is inRFC3339
15284 # text format.
15285 &quot;instancesBulkInsertOperationMetadata&quot;: {
15286 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15287 # Example key: zones/us-central1-a
15288 &quot;a_key&quot;: {
15289 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15290 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15291 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15292 # error.
15293 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15294 # if the flow is rolling forward or rolling back.
15295 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15296 },
15297 },
15298 },
15299 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15300 # Operation resources.
15301 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15302 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15303 # group of operations results from a `bulkInsert` API request.
15304 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15305 # `update`, or `delete`, and so on.
15306 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15307 # There is no requirement that this be linear or support any granularity of
15308 # operations. This should not be used to guess when the operation will be
15309 # complete. This number should monotonically increase as the operation
15310 # progresses.
15311 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15312 # applicable when performing regional operations.
15313 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15314 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
15315 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15316 # this field will contain information on all underlying zonal actions and
15317 # their state.
15318 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15319 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15320 # Example key: zones/us-central1-a
15321 &quot;a_key&quot;: {
15322 &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
15323 # populated.
15324 # different programming environments, including REST APIs and RPC APIs. It is
15325 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15326 # three pieces of data: error code, error message, and error details.
15327 #
15328 # You can find out more about this error model and how to work with it in the
15329 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15330 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15331 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15332 # message types for APIs to use.
15333 {
15334 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15335 },
15336 ],
15337 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15338 # user-facing error message should be localized and sent in the
15339 # google.rpc.Status.details field, or localized by the client.
15340 },
15341 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15342 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15343 },
15344 },
15345 },
15346 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15347 # This value is inRFC3339
15348 # text format.
15349 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15350 # following:
15351 # `PENDING`, `RUNNING`, or `DONE`.
15352 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15353 # operation.
15354 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15355 # of the target resource.
15356 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15357 # operations related to creating a snapshot, this points to the disk
15358 # that the snapshot was created from.
15359 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15360 # `[email protected]` or
15361 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15362 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15363 # operation, this field will be populated.
15364 {
15365 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15366 # Engine returns NO_RESULTS_ON_PAGE if there
15367 # are no results in the response.
15368 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15369 # value format. For example:
15370 #
15371 # &quot;data&quot;: [
15372 # {
15373 # &quot;key&quot;: &quot;scope&quot;,
15374 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15375 # }
15376 {
15377 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15378 # returned. For example, for warnings where there are no results in a list
15379 # request for a particular zone, this key might be scope and
15380 # the key value might be the zone name. Other examples might be a key
15381 # indicating a deprecated resource and a suggested replacement, or a
15382 # warning about invalid network settings (for example, if an instance
15383 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15384 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15385 },
15386 ],
15387 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15388 },
15389 ],
15390 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15391 # applicable when performing per-zone operations.
15392 }</pre>
15393 </div>
15394
15395 <div class="method">
15396 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
15397 <pre>Returns permissions that a caller has on the specified resource.
15398
15399 Args:
15400 project: string, Project ID for this request. (required)
15401 resource: string, Name or id of the resource for this request. (required)
15402 body: object, The request body.
15403 The object takes the form of:
15404
15405 {
15406 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
15407 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
15408 &quot;A String&quot;,
15409 ],
15410 }
15411
15412 x__xgafv: string, V1 error format.
15413 Allowed values
15414 1 - v1 error format
15415 2 - v2 error format
15416
15417 Returns:
15418 An object of the form:
15419
15420 {
15421 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
15422 # allowed.
15423 &quot;A String&quot;,
15424 ],
15425 }</pre>
15426 </div>
15427
15428 <div class="method">
15429 <code class="details" id="update">update(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
15430 <pre>Updates the specified BackendService resource with the data included in the
15431 request. For more information, seeBackend
15432 services overview.
15433
15434 Args:
15435 project: string, Project ID for this request. (required)
15436 backendService: string, Name of the BackendService resource to update. (required)
15437 body: object, The request body.
15438 The object takes the form of:
15439
15440 { # Represents a Backend Service resource.
15441 #
15442 # A backend service defines how Google Cloud load balancers distribute traffic.
15443 # The backend service configuration contains a set of values, such as the
15444 # protocol used to connect to backends, various distribution and session
15445 # settings, health checks, and timeouts. These settings provide fine-grained
15446 # control over how your load balancer behaves. Most of the settings have
15447 # default values that allow for easy configuration if you need to get started
15448 # quickly.
15449 #
15450 # Backend services in Google Compute Engine can be either regionally or
15451 # globally scoped.
15452 #
15453 # * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices)
15454 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices)
15455 #
15456 # For more information, seeBackend
15457 # Services.
15458 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
15459 # Load Balancers and Traffic Director and requires
15460 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
15461 #
15462 # If set to 0, the cookie is non-persistent and lasts only until
15463 # the end of the browser session (or equivalent). The maximum allowed value
15464 # is two weeks (1,209,600).
15465 #
15466 # Not supported when the backend service is referenced by a URL map that is
15467 # bound to target gRPC proxy that has validateForProxyless field set to true.
15468 &quot;allowMultinetwork&quot;: True or False, # A boolean flag enabling multi-network mesh. This field is only allowed with
15469 # load balancing scheme set to INTERNAL_SELF_MANAGED.
15470 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
15471 { # Message containing information of one individual backend.
15472 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
15473 # handle additional traffic or is fully loaded. For usage guidelines, see
15474 # Connection balancing mode.
15475 #
15476 # Backends must use compatible balancing modes. For more information, see
15477 # Supported balancing modes and target capacity settings and
15478 # Restrictions and guidance for instance groups.
15479 #
15480 # Note: Currently, if you use the API to configure incompatible balancing
15481 # modes, the configuration might be accepted even though it has no impact
15482 # and is ignored. Specifically, Backend.maxUtilization is ignored when
15483 # Backend.balancingMode is RATE. In the future, this incompatible combination
15484 # will be rejected.
15485 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
15486 # mode.
15487 # The default value is 1, which means the group serves up to
15488 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
15489 # completely drained, offering 0% of its available capacity. The valid ranges
15490 # are 0.0 and [0.1,1.0].
15491 # You cannot configure a setting larger than 0 and smaller than0.1.
15492 # You cannot configure a setting of 0 when there is only one
15493 # backend attached to the backend service.
15494 #
15495 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
15496 # internet NEGs, regional serverless NEGs, and PSC NEGs.
15497 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
15498 # BalancingMode.
15499 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
15500 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
15501 # Monitoring, but is not used for load balancing.
15502 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
15503 # balancing mode. The valid range is [0.0, 1.0].
15504 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
15505 # long and match the regular expression
15506 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
15507 # first character must be a lowercase letter, and all following
15508 # characters must be a dash, period, underscore, lowercase letter, or
15509 # digit, except the last character, which cannot be a dash, period, or
15510 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
15511 # field can only be used for a global or regional backend service with the
15512 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
15513 },
15514 ],
15515 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
15516 # create the resource.
15517 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
15518 # failover backend can be configured for a given BackendService.
15519 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
15520 # group or network endpoint
15521 # group (NEG) resource. To determine what types of backends a load
15522 # balancer supports, see the [Backend services
15523 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
15524 #
15525 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
15526 # or NEG. Partial URLs are not supported.
15527 #
15528 # If haPolicy is specified, backends must refer to NEG resources of type
15529 # GCE_VM_IP.
15530 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
15531 # guidelines, seeConnection
15532 # balancing mode and Utilization
15533 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
15534 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
15535 # guidelines, seeConnection
15536 # balancing mode and Utilization
15537 # balancing mode.
15538 #
15539 # Not available if the backend&#x27;s balancingMode isRATE.
15540 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
15541 # For usage guidelines, seeConnection
15542 # balancing mode and Utilization
15543 # balancing mode.
15544 #
15545 # Not available if the backend&#x27;s balancingMode isRATE.
15546 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
15547 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
15548 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
15549 # Not available if backend&#x27;s balancingMode is RATE
15550 # or CONNECTION.
15551 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
15552 # Not available if backend&#x27;s balancingMode is RATE
15553 # or CONNECTION.
15554 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
15555 # usage guidelines, seeRate
15556 # balancing mode and Utilization
15557 # balancing mode.
15558 #
15559 # Not available if the backend&#x27;s balancingMode isCONNECTION.
15560 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
15561 # guidelines, seeRate
15562 # balancing mode and Utilization
15563 # balancing mode.
15564 #
15565 # Not available if the backend&#x27;s balancingMode isCONNECTION.
15566 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
15567 # guidelines, seeRate
15568 # balancing mode and Utilization
15569 # balancing mode.
15570 #
15571 # Not available if the backend&#x27;s balancingMode isCONNECTION.
15572 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
15573 #
15574 # For usage guidelines, seeUtilization
15575 # balancing mode.
15576 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
15577 # the backend.
15578 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
15579 },
15580 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
15581 # sending traffic to backends with default preference. The possible values
15582 # are:
15583 #
15584 # - PREFERRED: Backends with this preference level will be
15585 # filled up to their capacity limits first, based on RTT.
15586 # - DEFAULT: If preferred backends don&#x27;t have enough
15587 # capacity, backends in this layer would be used and traffic would be
15588 # assigned based on the load balancing algorithm you use. This is the
15589 # default
15590 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
15591 # Attachment).
15592 # e.g.
15593 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
15594 # for Cloud Run service.
15595 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
15596 # for PSC Service Attachment.
15597 &quot;trafficDuration&quot;: &quot;A String&quot;,
15598 },
15599 ],
15600 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
15601 # specified load balancer types.
15602 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
15603 # Pragma or Authorization headers. Up to 5 headers can be specified.
15604 # The cache is bypassed for all cdnPolicy.cacheMode settings.
15605 { # Bypass the cache when the specified request headers are present,
15606 # e.g. Pragma or Authorization headers. Values are case insensitive.
15607 # The presence of such a header overrides the cache_mode setting.
15608 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
15609 # Values are case-insensitive.
15610 },
15611 ],
15612 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
15613 # CDN.
15614 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
15615 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
15616 &quot;A String&quot;,
15617 ],
15618 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
15619 # The name=value pair will be used in the cache key Cloud CDN generates.
15620 &quot;A String&quot;,
15621 ],
15622 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
15623 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
15624 # query_string_whitelist and query_string_blacklist. If neither is set, the
15625 # entire query string will be included. If false, the query string will be
15626 # excluded from the cache key entirely.
15627 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
15628 # parameters will be included. Either specify query_string_whitelist or
15629 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
15630 # not treated as delimiters.
15631 &quot;A String&quot;,
15632 ],
15633 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
15634 # parameters will be excluded. Either specify query_string_whitelist or
15635 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
15636 # not treated as delimiters.
15637 &quot;A String&quot;,
15638 ],
15639 },
15640 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
15641 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
15642 # headers to cache content. Responses without these headers will not be
15643 # cached at Google&#x27;s edge, and will require a full trip to the origin on
15644 # every request, potentially impacting performance and increasing load on
15645 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
15646 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
15647 # Warning: this may result in Cloud CDN caching private,
15648 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
15649 # including common image formats, media (video and audio), and web assets
15650 # (JavaScript and CSS). Requests and responses that are marked as
15651 # uncacheable, as well as dynamic content (including HTML), will not be
15652 # cached.
15653 #
15654 # If no value is provided for cdnPolicy.cacheMode, it defaults
15655 # to CACHE_ALL_STATIC.
15656 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
15657 # used to clamp the max-age (or Expires) value sent to the client. With
15658 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
15659 # response max-age directive, along with a &quot;public&quot; directive. For
15660 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
15661 # from the origin (if specified), or else sets the response max-age
15662 # directive to the lesser of the client_ttl and default_ttl, and also
15663 # ensures a &quot;public&quot; cache-control directive is present.
15664 # If a client TTL is not specified, a default value (1 hour) will be used.
15665 # The maximum allowed value is 31,622,400s (1 year).
15666 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
15667 # responses that do not have an existing valid TTL (max-age or s-maxage).
15668 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
15669 # The value of defaultTTL cannot be set to a value greater than that of
15670 # maxTTL, but can be equal.
15671 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
15672 # will overwrite the TTL set in all responses. The maximum allowed value is
15673 # 31,622,400s (1 year), noting that infrequently accessed objects may be
15674 # evicted from the cache before the defined TTL.
15675 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
15676 # origin.
15677 # Cache directives that attempt to set a max-age or s-maxage higher than
15678 # this, or an Expires header more than maxTTL seconds in the future will
15679 # be capped at the value of maxTTL, as if it were the value of an
15680 # s-maxage Cache-Control directive.
15681 # Headers sent to the client will not be modified.
15682 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
15683 # The maximum allowed value is 31,622,400s (1 year), noting that
15684 # infrequently accessed objects may be evicted from the cache before
15685 # the defined TTL.
15686 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
15687 # to apply fine-grained caching for common errors or redirects.
15688 # This can reduce the load on your origin and improve end-user
15689 # experience by reducing response latency.
15690 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
15691 # negative caching applies to responses with the specified response code
15692 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
15693 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
15694 # to all responses with the specified response code, and override any
15695 # caching headers.
15696 # By default, Cloud CDN will apply the following default TTLs to these
15697 # status codes:
15698 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
15699 # HTTP 404 (Not Found), 410 (Gone),
15700 # 451 (Unavailable For Legal Reasons): 120s
15701 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
15702 # These defaults can be overridden in negative_caching_policy.
15703 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
15704 # negative_caching must be enabled to configure negative_caching_policy.
15705 # Omitting the policy and leaving negative_caching enabled will use
15706 # Cloud CDN&#x27;s default cache TTLs.
15707 # Note that when specifying an explicit negative_caching_policy, you
15708 # should take care to specify a cache TTL for all response codes
15709 # that you wish to cache. Cloud CDN will not apply any default
15710 # negative caching when a policy exists.
15711 { # Specify CDN TTLs for response error codes.
15712 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
15713 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
15714 # specified as values, and you cannot specify a status code more than
15715 # once.
15716 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
15717 # corresponding status code.
15718 # The maximum allowed value is 1800s (30 minutes), noting that
15719 # infrequently accessed objects may be evicted from the cache before the
15720 # defined TTL.
15721 },
15722 ],
15723 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
15724 # requests into a small number of requests to the origin.
15725 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
15726 # content with the origin, or when an error is encountered when refreshing
15727 # the cache.
15728 # This setting defines the default &quot;max-stale&quot; duration for any cached
15729 # responses that do not specify a max-stale directive. Stale responses that
15730 # exceed the TTL configured here will not be served. The default limit
15731 # (max-stale) is 86400s (1 day), which will allow stale content to be
15732 # served up to this limit beyond the max-age (or s-maxage) of a cached
15733 # response.
15734 # The maximum allowed value is 604800 (1 week).
15735 # Set this to zero (0) to disable serve-while-stale.
15736 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
15737 # considered fresh. After this time period, the response will be
15738 # revalidated before being served. Defaults to 1hr (3600s). When serving
15739 # responses to signed URL requests, Cloud CDN will internally behave as
15740 # though all responses from this backend had a &quot;Cache-Control:
15741 # public, max-age=[TTL]&quot; header, regardless of any existing
15742 # Cache-Control header. The actual headers served in responses will not be
15743 # altered.
15744 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
15745 &quot;A String&quot;,
15746 ],
15747 },
15748 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
15749 # backend service.
15750 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
15751 # as a count of seconds and fractions of seconds at nanosecond
15752 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
15753 # or &quot;month&quot;. Range is approximately 10,000 years.
15754 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
15755 # Durations less than one second are represented with a 0
15756 # `seconds` field and a positive `nanos` field. Must be from 0
15757 # to 999,999,999 inclusive.
15758 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
15759 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
15760 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
15761 },
15762 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
15763 # there is no limit.
15764 #
15765 # Not supported when the backend service is referenced by a URL map that is
15766 # bound to target gRPC proxy that has validateForProxyless field set to true.
15767 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
15768 # not specified, there is no limit.
15769 #
15770 # Not supported when the backend service is referenced by a URL map that is
15771 # bound to target gRPC proxy that has validateForProxyless field set to true.
15772 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
15773 # service. If not specified, there is no limit.
15774 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
15775 # This parameter is respected by both the HTTP/1.1 and HTTP/2
15776 # implementations. If not specified, there is no limit. Setting this
15777 # parameter to 1 will effectively disable keep alive.
15778 #
15779 # Not supported when the backend service is referenced by a URL map that is
15780 # bound to target gRPC proxy that has validateForProxyless field set to true.
15781 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
15782 # not specified, the default is 1.
15783 #
15784 # Not supported when the backend service is referenced by a URL map that is
15785 # bound to target gRPC proxy that has validateForProxyless field set to true.
15786 },
15787 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
15788 # the client&#x27;s Accept-Encoding header.
15789 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
15790 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
15791 # instance. For supported load balancers and protocols, as described inEnabling
15792 # connection draining.
15793 },
15794 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
15795 # tracking policy settings are only available for external passthrough
15796 # Network Load Balancers and internal passthrough Network Load Balancers.
15797 #
15798 # connectionTrackingPolicy cannot be specified with haPolicy.
15799 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
15800 # value is DEFAULT_FOR_PROTOCOL.
15801 #
15802 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
15803 # persist on unhealthy backends only for connection-oriented protocols
15804 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
15805 # Affinity is configured for 5-tuple. They do not persist forUDP.
15806 #
15807 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
15808 # the existing connections on the unhealthy backend are never persisted on
15809 # the unhealthy backend. They are always diverted to newly selected healthy
15810 # backends (unless all backends are unhealthy).
15811 #
15812 # If set to ALWAYS_PERSIST, existing connections always
15813 # persist on unhealthy backends regardless of protocol and session
15814 # affinity. It is generally not recommended to use this mode overriding the
15815 # default.
15816 #
15817 # For more details, see [Connection Persistence for Network Load
15818 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
15819 # and [Connection Persistence for Internal TCP/UDP Load
15820 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
15821 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
15822 # Balancers. This option is not available publicly.
15823 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
15824 # matching traffic (in seconds).
15825 #
15826 # For internal passthrough Network Load Balancers:
15827 #
15828 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
15829 # - It can be set only if Connection Tracking is less than 5-tuple
15830 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
15831 # Mode is PER_SESSION).
15832 #
15833 #
15834 #
15835 # For external passthrough Network Load Balancers the default is 60
15836 # seconds. This option is not available publicly.
15837 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
15838 # options:
15839 #
15840 # - PER_CONNECTION: This is the default mode. The Connection
15841 # Tracking is performed as per the Connection Key (default Hash Method) for
15842 # the specific protocol.
15843 # - PER_SESSION: The Connection Tracking is performed as per
15844 # the configured Session Affinity. It matches the configured Session
15845 # Affinity.
15846 #
15847 #
15848 #
15849 # For more details, see [Tracking Mode for Network Load
15850 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
15851 # and [Tracking Mode for Internal TCP/UDP Load
15852 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
15853 },
15854 &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
15855 # affinity based on HTTP headers, cookies or other properties. This load
15856 # balancing policy is applicable only for HTTP connections. The affinity to a
15857 # particular destination host will be lost when one or more hosts are
15858 # added/removed from the destination service. This field specifies parameters
15859 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
15860 #
15861 # This field is applicable to either:
15862 #
15863 # - A regional backend service with the service protocol set to HTTP,
15864 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
15865 # INTERNAL_MANAGED.
15866 # - A global backend service with the
15867 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
15868 &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
15869 # be used as the hash key for the consistent hash load balancer. If the
15870 # cookie is not present, it will be generated. This field is applicable if
15871 # the sessionAffinity is set to HTTP_COOKIE.
15872 #
15873 # Not supported when the backend service is referenced by a URL map that is
15874 # bound to target gRPC proxy that has validateForProxyless field set to true.
15875 # for load balancing policies that use a consistent hash.
15876 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
15877 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
15878 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
15879 # as a count of seconds and fractions of seconds at nanosecond
15880 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
15881 # or &quot;month&quot;. Range is approximately 10,000 years.
15882 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
15883 # Durations less than one second are represented with a 0
15884 # `seconds` field and a positive `nanos` field. Must be from 0
15885 # to 999,999,999 inclusive.
15886 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
15887 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
15888 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
15889 },
15890 },
15891 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
15892 # applicable if the sessionAffinity is set toHEADER_FIELD.
15893 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
15894 # 1024. Larger ring sizes result in more granular load distributions. If the
15895 # number of hosts in the load balancing pool is larger than the ring size,
15896 # each host will be assigned a single virtual node.
15897 },
15898 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
15899 # text format.
15900 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
15901 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
15902 # locality_lb_policy.
15903 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
15904 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
15905 # long and match the regular expression
15906 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
15907 # first character must be a lowercase letter, and all following
15908 # characters must be a dash, period, underscore, lowercase letter, or
15909 # digit, except the last character, which cannot be a dash, period, or
15910 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
15911 # field can only be used for a global or regional backend service with the
15912 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
15913 },
15914 ],
15915 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
15916 # custom
15917 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
15918 &quot;A String&quot;,
15919 ],
15920 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
15921 # custom
15922 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
15923 &quot;A String&quot;,
15924 ],
15925 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
15926 # create the resource.
15927 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
15928 # backend service with dynamic forwarding feature which together with Service
15929 # Extension allows customized and complex routing logic.
15930 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
15931 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
15932 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
15933 },
15934 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
15935 # service. Some ranges are restricted: Restricted
15936 # ranges.
15937 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
15938 },
15939 },
15940 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
15941 # this backend service.
15942 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
15943 # global external Application Load Balancer.
15944 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
15945 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
15946 #
15947 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
15948 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
15949 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
15950 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
15951 # externalManagedMigrationTestingPercentage.
15952 #
15953 # Rolling back a migration requires the states to be set in reverse order. So
15954 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
15955 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
15956 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
15957 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
15958 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
15959 # external Application Load Balancer.
15960 #
15961 # The value of this field must be in the range [0, 100].
15962 #
15963 # Session affinity options will slightly affect this routing behavior, for
15964 # more details, see:Session
15965 # Affinity.
15966 #
15967 # This value can only be set if the loadBalancingScheme in the BackendService
15968 # is set to EXTERNAL (when using the classic Application Load Balancer) and
15969 # the migration state is TEST_BY_PERCENTAGE.
15970 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
15971 # as a backup (failover) backend.
15972 # For load balancers that have configurable failover:
15973 # [Internal passthrough Network Load
15974 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
15975 # and [external passthrough Network Load
15976 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
15977 #
15978 # failoverPolicy cannot be specified with haPolicy.
15979 # failover:
15980 # [Internal passthrough Network Load
15981 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
15982 # and [external passthrough
15983 # Network Load
15984 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
15985 # On failover or failback, this field indicates whether connection draining
15986 # will be honored. Google Cloud has a fixed connection draining timeout of
15987 # 10 minutes. A setting of true terminates existing TCP
15988 # connections to the active pool during failover and failback, immediately
15989 # draining traffic. A setting of false allows existing TCP
15990 # connections to persist, even on VMs no longer in the active pool, for up
15991 # to the duration of the connection draining timeout (10 minutes).
15992 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
15993 #
15994 # The default is false.
15995 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
15996 # load balancer are dropped when all primary and all backup backend VMs are
15997 # unhealthy.If set to false, connections are distributed
15998 # among all primary VMs when all primary and all backup backend VMs are
15999 # unhealthy.
16000 # For load balancers that have configurable
16001 # failover:
16002 # [Internal passthrough
16003 # Network Load
16004 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
16005 # and [external passthrough
16006 # Network Load
16007 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
16008 # The default is false.
16009 &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
16010 # failover when the number of healthy primary VMs equals zero.
16011 # For all other values, the load balancer performs a failover when the
16012 # total number of healthy primary VMs is less than this ratio.
16013 # For load balancers that have configurable
16014 # failover:
16015 # [Internal TCP/UDP Load
16016 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
16017 # and [external TCP/UDP Load
16018 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
16019 },
16020 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
16021 # This field is used in optimistic locking. This field will be ignored when
16022 # inserting a BackendService. An up-to-date fingerprint must be provided in
16023 # order to update the BackendService, otherwise the request will
16024 # fail with error 412 conditionNotMet.
16025 #
16026 # To see the latest fingerprint, make a get() request to
16027 # retrieve a BackendService.
16028 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
16029 # Protocol Forwarding.
16030 #
16031 # The backends of this regional backend service must only specify zonal
16032 # network endpoint groups (NEGs) of type GCE_VM_IP.
16033 #
16034 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
16035 # regional backend service must set the network field. All zonal NEGs must
16036 # belong to the same network. However, individual NEGs can
16037 # belong to different subnetworks of that network.
16038 #
16039 # When haPolicy is specified, the set of attached network endpoints across
16040 # all backends comprise an High Availability domain from which one endpoint
16041 # is selected as the active endpoint (the leader) that receives all
16042 # traffic.
16043 #
16044 # haPolicy can be added only at backend service creation time. Once set up,
16045 # it cannot be deleted.
16046 #
16047 # Note that haPolicy is not for load balancing, and therefore cannot be
16048 # specified with sessionAffinity, connectionTrackingPolicy, and
16049 # failoverPolicy.
16050 #
16051 # haPolicy requires customers to be responsible for tracking backend
16052 # endpoint health and electing a leader among the healthy endpoints.
16053 # Therefore, haPolicy cannot be specified with healthChecks.
16054 #
16055 # haPolicy can only be specified for External Passthrough Network Load
16056 # Balancers and Internal Passthrough Network Load Balancers.
16057 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
16058 # achieve it.
16059 #
16060 # Supported values are:
16061 #
16062 # - DISABLED: Fast IP Move is disabled. You can only use the
16063 # haPolicy.leader API to update the leader.
16064 # - &gt;GARP_RA: Provides a method to very quickly define a new network
16065 # endpoint as the leader. This method is faster than updating the leader
16066 # using the haPolicy.leader API. Fast IP move works as follows: The VM
16067 # hosting the network endpoint that should become the new leader sends
16068 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
16069 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
16070 # temporarily associates the forwarding rule IP address with that VM, and
16071 # both new and in-flight packets are quickly delivered to that VM.
16072 #
16073 #
16074 #
16075 # Note the important properties of the Fast IP Move functionality:
16076 #
16077 # - The GARP/RA-initiated re-routing stays active for approximately 20
16078 # minutes. After triggering fast failover, you must also
16079 # appropriately set the haPolicy.leader.
16080 # - The new leader instance should continue to send GARP/RA packets
16081 # periodically every 10 seconds until at least 10 minutes after updating
16082 # the haPolicy.leader (but stop immediately if it is no longer the leader).
16083 # - After triggering a fast failover, we recommend that you wait at least
16084 # 3 seconds before sending another GARP/RA packet from a different VM
16085 # instance to avoid race conditions.
16086 # - Don&#x27;t send GARP/RA packets from different VM
16087 # instances at the same time. If multiple instances continue to send
16088 # GARP/RA packets, traffic might be routed to different destinations in an
16089 # alternating order. This condition ceases when a single instance
16090 # issues a GARP/RA packet.
16091 # - The GARP/RA request always takes priority over the leader API.
16092 # Using the haPolicy.leader API to change the leader to a different
16093 # instance will have no effect until the GARP/RA request becomes
16094 # inactive.
16095 # - The GARP/RA packets should follow the GARP/RA
16096 # Packet Specifications..
16097 # - When multiple forwarding rules refer to a regional backend service,
16098 # you need only send a GARP or RA packet for a single forwarding rule
16099 # virtual IP. The virtual IPs for all forwarding rules targeting the same
16100 # backend service will also be moved to the sender of the GARP or RA
16101 # packet.
16102 #
16103 #
16104 #
16105 # The following are the Fast IP Move limitations (that is, when fastIPMove
16106 # is not DISABLED):
16107 #
16108 # - Multiple forwarding rules cannot use the same IP address if one of
16109 # them refers to a regional backend service with fastIPMove.
16110 # - The regional backend service must set the network field, and all
16111 # NEGs must belong to that network. However, individual
16112 # NEGs can belong to different subnetworks of that network.
16113 # - The maximum number of network endpoints across all backends of a
16114 # backend service with fastIPMove is 32.
16115 # - The maximum number of backend services with fastIPMove that can have
16116 # the same network endpoint attached to one of its backends is 64.
16117 # - The maximum number of backend services with fastIPMove in a VPC in a
16118 # region is 64.
16119 # - The network endpoints that are attached to a backend of a backend
16120 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
16121 # - Traffic directed to the leader by a static route next hop will not be
16122 # redirected to a new leader by fast failover. Such traffic will only be
16123 # redirected once an haPolicy.leader update has taken effect. Only traffic
16124 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
16125 # fast failover.
16126 #
16127 #
16128 # haPolicy.fastIPMove can be set only at backend service creation time.
16129 # Once set, it cannot be updated.
16130 #
16131 # By default, fastIpMove is set to DISABLED.
16132 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
16133 # this service as the active endpoint (the leader) that receives all
16134 # traffic.
16135 #
16136 # When the leader changes, there is no connection draining to persist
16137 # existing connections on the old leader.
16138 #
16139 # You are responsible for selecting a suitable endpoint as the
16140 # leader. For example, preferring a healthy endpoint over unhealthy ones.
16141 # Note that this service does not track backend endpoint health, and
16142 # selects the configured leader unconditionally.
16143 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
16144 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
16145 # that the leader is attached to.
16146 #
16147 # The leader&#x27;s backendGroup must already be specified as a backend of
16148 # this backend service. Removing a backend that is designated as the
16149 # leader&#x27;s backendGroup is not permitted.
16150 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
16151 # designated as the leader.
16152 #
16153 # This network endpoint cannot be detached from the NEG specified in
16154 # the haPolicy.leader.backendGroup until the leader is updated with
16155 # another network endpoint, or the leader is removed from the haPolicy.
16156 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
16157 # instance must already be attached to the NEG specified in the
16158 # haPolicy.leader.backendGroup.
16159 #
16160 # The name must be 1-63 characters long, and comply with RFC1035.
16161 # Authorization requires the following IAM permission on the
16162 # specified resource instance: compute.instances.use
16163 },
16164 },
16165 },
16166 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
16167 # httpsHealthChecks (legacy) resource for health checking this backend
16168 # service. Not all backend services support legacy health checks. See
16169 # Load balancer guide. Currently, at most one health check can be
16170 # specified for each backend service. Backend services with
16171 # instance group or zonal NEG backends must have a health check unless
16172 # haPolicy is specified. Backend services with internet or serverless NEG
16173 # backends must not have a health check.
16174 #
16175 # healthChecks[] cannot be specified with haPolicy.
16176 &quot;A String&quot;,
16177 ],
16178 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
16179 # Not available for internal passthrough Network Load Balancers and external
16180 # passthrough Network Load Balancers.
16181 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
16182 # incoming requests.
16183 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
16184 &quot;oauth2ClientInfo&quot;: { # [Input Only] OAuth client info required to generate client id to be used
16185 # for IAP.
16186 &quot;applicationName&quot;: &quot;A String&quot;, # Application name to be used in OAuth consent screen.
16187 &quot;clientName&quot;: &quot;A String&quot;, # Name of the client to be generated.
16188 # Optional - If not provided, the name will be autogenerated by the
16189 # backend.
16190 &quot;developerEmailAddress&quot;: &quot;A String&quot;, # Developer&#x27;s information to be used in OAuth consent screen.
16191 },
16192 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
16193 # For security reasons, this value cannot be retrieved via the API.
16194 # Instead, the SHA-256 hash of the value is returned in the
16195 # oauth2ClientSecretSha256 field.
16196 #
16197 # @InputOnly
16198 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
16199 },
16200 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
16201 # defined by the server.
16202 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
16203 # from the client to the backend for proxyless gRPC).
16204 # The possible values are:
16205 #
16206 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
16207 # backend service (Instance Group, Managed Instance Group, Network Endpoint
16208 # Group), regardless of traffic from the client to the proxy. Only IPv4
16209 # health checks are used to check the health of the backends. This is the
16210 # default setting.
16211 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
16212 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
16213 # address).
16214 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
16215 # backend service (Instance Group, Managed Instance Group, Network Endpoint
16216 # Group), regardless of traffic from the client to the proxy. Only IPv6
16217 # health checks are used to check the health of the backends.
16218 #
16219 #
16220 #
16221 # This field is applicable to either:
16222 #
16223 # - Advanced global external Application Load Balancer (load balancing
16224 # scheme EXTERNAL_MANAGED),
16225 # - Regional external Application Load
16226 # Balancer,
16227 # - Internal proxy Network Load Balancer (load balancing
16228 # scheme INTERNAL_MANAGED),
16229 # - Regional internal Application Load
16230 # Balancer (load balancing scheme INTERNAL_MANAGED),
16231 # - Traffic
16232 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
16233 # INTERNAL_SELF_MANAGED).
16234 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
16235 # for backend services.
16236 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
16237 # created for one type of load balancer cannot be used with another.
16238 # For more information, refer toChoosing
16239 # a load balancer.
16240 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
16241 # preference. When you use localityLbPolicies, you must set at least one
16242 # value for either the localityLbPolicies[].policy or the
16243 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
16244 # value set in the localityLbPolicy field.
16245 #
16246 # For an example of how to use this field, seeDefine
16247 # a list of preferred policies.
16248 #
16249 # Caution: This field and its children are intended for use in a service mesh
16250 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
16251 # that have this configuration.
16252 { # Container for either a built-in LB policy supported by gRPC or Envoy or
16253 # a custom one implemented by the end user.
16254 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
16255 # deployed with the client.
16256 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
16257 # by a locally installed custom policy implementation.
16258 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
16259 #
16260 # The value should match the name of a custom implementation registered
16261 # on the gRPC clients. It should follow protocol buffer message naming
16262 # conventions and include the full path (for example,
16263 # myorg.CustomLbPolicy). The maximum length is 256 characters.
16264 #
16265 # Do not specify the same custom policy more than once for a
16266 # backend. If you do, the configuration is rejected.
16267 #
16268 # For an example of how to use this field, seeUse
16269 # a custom policy.
16270 },
16271 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
16272 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
16273 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
16274 # about these values, see the description of localityLbPolicy.
16275 #
16276 # Do not specify the same policy more than once for a
16277 # backend. If you do, the configuration is rejected.
16278 },
16279 },
16280 ],
16281 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
16282 # possible values are:
16283 #
16284 # - ROUND_ROBIN: This is a simple policy in which each healthy
16285 # backend is selected in round robin order. This is the default.
16286 # - LEAST_REQUEST: An O(1) algorithm which
16287 # selects two random healthy hosts and picks the host which has fewer active
16288 # requests.
16289 # - RING_HASH: The ring/modulo hash load balancer implements
16290 # consistent hashing to backends. The algorithm has the property that the
16291 # addition/removal of a host from a set of N hosts only affects 1/N of the
16292 # requests.
16293 # - RANDOM: The load balancer selects a random healthy
16294 # host.
16295 # - ORIGINAL_DESTINATION: Backend host is selected
16296 # based on the client connection metadata, i.e., connections are opened to
16297 # the same address as the destination address of the incoming connection
16298 # before the connection was redirected to the load balancer.
16299 # - MAGLEV: used as a drop in replacement for the ring hash
16300 # load balancer. Maglev is not as stable as ring hash but has faster table
16301 # lookup build times and host selection times. For more information about
16302 # Maglev, see Maglev:
16303 # A Fast and Reliable Software Network Load Balancer.
16304 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
16305 # Load Balancing using weights computed from Backend reported Custom Metrics.
16306 # If set, the Backend Service responses are expected to contain non-standard
16307 # HTTP response header field Endpoint-Load-Metrics. The reported
16308 # metrics to use for computing the weights are specified via thecustomMetrics field.
16309 #
16310 # This field is applicable to either:
16311 # - A regional backend service with the service protocol set to HTTP,
16312 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
16313 # INTERNAL_MANAGED.
16314 # - A global backend service with the
16315 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
16316 # EXTERNAL_MANAGED.
16317 #
16318 #
16319 # If sessionAffinity is not configured—that is, if session
16320 # affinity remains at the default value of NONE—then the
16321 # default value for localityLbPolicy
16322 # is ROUND_ROBIN. If session affinity is set to a value other
16323 # than NONE,
16324 # then the default value for localityLbPolicy isMAGLEV.
16325 #
16326 # Only ROUND_ROBIN and RING_HASH are supported
16327 # when the backend service is referenced by a URL map that is bound to
16328 # target gRPC proxy that has validateForProxyless field set to true.
16329 #
16330 # localityLbPolicy cannot be specified with haPolicy.
16331 &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
16332 # by this backend service. If logging is enabled, logs will be exported to
16333 # Stackdriver.
16334 # backend service.
16335 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
16336 # traffic served by this backend service. The default value is false.
16337 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
16338 { # Determines which HTTP headers will be logged to Stackdriver.
16339 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
16340 },
16341 ],
16342 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
16343 { # Determines which HTTP headers will be logged to Stackdriver.
16344 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
16345 },
16346 ],
16347 &quot;optional&quot;: &quot;A String&quot;, # Deprecated in favor of optionalMode.
16348 # This field can only be specified if logging is enabled for this backend
16349 # service. Configures whether all, none or a subset of optional fields
16350 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
16351 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
16352 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
16353 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
16354 # of optional fields you want to include in the logs. For example:
16355 # serverInstance, serverGkeDetails.cluster,
16356 # serverGkeDetails.pod.podNamespace
16357 &quot;A String&quot;,
16358 ],
16359 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
16360 # service. Configures whether all, none or a subset of optional fields
16361 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
16362 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
16363 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
16364 # service. The value of the field must be in [0, 1]. This configures the
16365 # sampling rate of requests to the load balancer where 1.0 means all logged
16366 # requests are reported and 0.0 means no logged requests are reported. The
16367 # default value is 1.0.
16368 },
16369 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
16370 # service. Duration is computed from the beginning of the stream until the
16371 # response has been completely processed, including all retries. A stream
16372 # that does not complete in this duration is closed.
16373 #
16374 # If not specified, there will be no timeout limit, i.e. the maximum
16375 # duration is infinite.
16376 #
16377 # This value can be overridden in the PathMatcher configuration of the
16378 # UrlMap that references this backend service.
16379 #
16380 # This field is only allowed when the loadBalancingScheme of
16381 # the backend service is INTERNAL_SELF_MANAGED.
16382 # as a count of seconds and fractions of seconds at nanosecond
16383 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
16384 # or &quot;month&quot;. Range is approximately 10,000 years.
16385 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
16386 # Durations less than one second are represented with a 0
16387 # `seconds` field and a positive `nanos` field. Must be from 0
16388 # to 999,999,999 inclusive.
16389 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
16390 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
16391 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
16392 },
16393 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
16394 # controller and read by the backend RCTH
16395 &quot;a_key&quot;: &quot;A String&quot;,
16396 },
16397 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
16398 # The name must be 1-63 characters long, and comply withRFC1035.
16399 # Specifically, the name must be 1-63 characters long and match the regular
16400 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
16401 # character must be a lowercase letter, and all following characters must
16402 # be a dash, lowercase letter, or digit, except the last character, which
16403 # cannot be a dash.
16404 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
16405 #
16406 # This field must be set for Internal Passthrough Network Load Balancers when
16407 # the haPolicy is enabled, and for External Passthrough Network Load
16408 # Balancers when the haPolicy fastIpMove is enabled.
16409 #
16410 # 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.
16411 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
16412 # Load Balancers.
16413 #
16414 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
16415 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
16416 # endpoints in the local zone.
16417 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
16418 # possible values are:
16419 #
16420 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
16421 # is disabled. The load balancer distributes new connections to all
16422 # healthy backend endpoints across all zones.
16423 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
16424 # enabled. The load balancer distributes new connections to all healthy
16425 # backend endpoints in the local zone only. If there are no healthy
16426 # backend endpoints in the local zone, the load balancer distributes
16427 # new connections to all backend endpoints in the local zone.
16428 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
16429 # enabled. The load balancer distributes new connections to all healthy
16430 # backend endpoints in the local zone only. If there aren&#x27;t enough
16431 # healthy backend endpoints in the local zone, the load balancer
16432 # distributes new connections to all healthy backend endpoints across all
16433 # zones.
16434 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
16435 # of healthy backend endpoints in a zone to the count of backend
16436 # endpoints in that same zone is equal to or above this threshold, the
16437 # load balancer distributes new connections to all healthy endpoints in
16438 # the local zone only. When the ratio of the count of healthy backend
16439 # endpoints in a zone to the count of backend endpoints in that same
16440 # zone is below this threshold, the load balancer distributes all new
16441 # connections to all healthy endpoints across all zones.
16442 },
16443 },
16444 &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.
16445 # the backend service.
16446 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
16447 # service.
16448 },
16449 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
16450 # load balancing pool of each individual proxy instance that processes the
16451 # traffic for the given backend service. If not set, this feature is
16452 # considered disabled.
16453 #
16454 # Results of the outlier detection algorithm (ejection of endpoints from the
16455 # load balancing pool and returning them back to the pool) are executed
16456 # independently by each proxy instance of the load balancer. In most cases,
16457 # more than one proxy instance handles the traffic received by a backend
16458 # service. Thus, it is possible that an unhealthy endpoint is detected and
16459 # ejected by only some of the proxies, and while this happens, other proxies
16460 # may continue to send requests to the same unhealthy endpoint until they
16461 # detect and eject the unhealthy endpoint.
16462 #
16463 # Applicable backend endpoints can be:
16464 #
16465 # - VM instances in an Instance Group
16466 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
16467 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
16468 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
16469 # Functions Services
16470 # - Private Service Connect NEGs, that resolve to
16471 # Google-managed regional API endpoints or managed services published using
16472 # Private Service Connect
16473 #
16474 #
16475 #
16476 # Applicable backend service types can be:
16477 #
16478 # - A global backend service with the loadBalancingScheme set to
16479 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
16480 # - A regional backend
16481 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
16482 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
16483 # supported for Serverless NEGs.
16484 #
16485 #
16486 #
16487 # Not supported when the backend service is referenced by a URL map that is
16488 # bound to target gRPC proxy that has validateForProxyless field set to true.
16489 # pool for the backend service.
16490 &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
16491 # or 30s.
16492 #
16493 # After a backend endpoint is returned back to the load balancing pool, it
16494 # can be ejected again in another ejection analysis. Thus, the total ejection
16495 # time is equal to the base ejection time multiplied by the number of times
16496 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
16497 # as a count of seconds and fractions of seconds at nanosecond
16498 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
16499 # or &quot;month&quot;. Range is approximately 10,000 years.
16500 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
16501 # Durations less than one second are represented with a 0
16502 # `seconds` field and a positive `nanos` field. Must be from 0
16503 # to 999,999,999 inclusive.
16504 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
16505 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
16506 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
16507 },
16508 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
16509 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
16510 # return code qualifies as an error. Defaults to 5.
16511 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
16512 # connection errors that are mapped to one of those status codes) before a
16513 # consecutive gateway failure ejection occurs. Defaults to 3.
16514 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
16515 # outlier status is detected through consecutive 5xx. This setting can be
16516 # used to disable ejection or to ramp it up slowly. Defaults to 0.
16517 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
16518 # outlier status is detected through consecutive gateway failures. This
16519 # setting can be used to disable ejection or to ramp it up slowly. Defaults
16520 # to 100.
16521 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
16522 # outlier status is detected through success rate statistics. This setting
16523 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
16524 #
16525 # Not supported when the backend service uses Serverless NEG.
16526 &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
16527 # ejections and backend endpoints being returned to service. The interval is
16528 # equal to the number of seconds as defined in
16529 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
16530 # in outlierDetection.interval.nanos. Defaults to 1 second.
16531 # as a count of seconds and fractions of seconds at nanosecond
16532 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
16533 # or &quot;month&quot;. Range is approximately 10,000 years.
16534 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
16535 # Durations less than one second are represented with a 0
16536 # `seconds` field and a positive `nanos` field. Must be from 0
16537 # to 999,999,999 inclusive.
16538 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
16539 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
16540 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
16541 },
16542 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
16543 # backend service that can be ejected if the ejection conditions are met.
16544 # Defaults to 50%.
16545 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
16546 # enough request volume to detect success rate outliers. If the number of
16547 # backend endpoints is fewer than this setting, outlier detection via success
16548 # rate statistics is not performed for any backend endpoint in the load
16549 # balancing pool. Defaults to 5.
16550 #
16551 # Not supported when the backend service uses Serverless NEG.
16552 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
16553 # (as defined by the interval duration above) to include this backend
16554 # endpoint in success rate based outlier detection. If the volume is lower
16555 # than this setting, outlier detection via success rate statistics is not
16556 # performed for that backend endpoint. Defaults to 100.
16557 #
16558 # Not supported when the backend service uses Serverless NEG.
16559 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
16560 # outlier ejection. The ejection threshold is the difference between the mean
16561 # success rate, and the product of this factor and the standard deviation of
16562 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
16563 # is divided by a thousand to get a double. That is, if the desired factor
16564 # is 1.9, the runtime value should be 1900. Defaults to 1900.
16565 #
16566 # Not supported when the backend service uses Serverless NEG.
16567 },
16568 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
16569 # as part of resource payload.
16570 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
16571 # Tag keys and values have the same definition as resource
16572 # manager tags. The field is allowed for INSERT
16573 # only. The keys/values to set on the resource should be specified in
16574 # either ID { : } or Namespaced format
16575 # { : }.
16576 # For example the following are valid inputs:
16577 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
16578 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
16579 # Note:
16580 # * Invalid combinations of ID &amp; namespaced format is not supported. For
16581 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
16582 &quot;a_key&quot;: &quot;A String&quot;,
16583 },
16584 },
16585 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
16586 # the backend. The default value is 80.
16587 # For internal passthrough Network Load Balancers and external passthrough
16588 # Network Load Balancers, omit port.
16589 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
16590 # communication to the backend VMs in that group. The
16591 # named port must be [defined on each backend instance
16592 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
16593 # This parameter has no meaning if the backends are NEGs. For internal
16594 # passthrough Network Load Balancers and external passthrough Network Load
16595 # Balancers, omit port_name.
16596 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
16597 # with backends.
16598 #
16599 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
16600 # depending on the chosen load balancer or Traffic Director configuration.
16601 # Refer to the documentation for the load balancers or for Traffic Director
16602 # for more information.
16603 #
16604 # Must be set to GRPC when the backend service is referenced by a URL map
16605 # that is bound to target gRPC proxy.
16606 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
16607 # resides. This field is not applicable to global backend services.
16608 # You must specify this field as part of the HTTP request URL. It is
16609 # not settable as a field in the request body.
16610 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
16611 # backend service.
16612 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
16613 # service. This field is applicable to a global backend service with the
16614 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
16615 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
16616 &quot;authenticationPolicy&quot;: { # [Deprecated] The authentication settings for the backend service. # [Deprecated] Authentication policy defines what authentication methods can
16617 # be accepted on backends, and if authenticated, which method/certificate
16618 # will set the request principal.
16619 # request principal.
16620 # The authentication settings for the backend service.
16621 &quot;origins&quot;: [ # List of authentication methods that can be used for origin authentication.
16622 # Similar to peers, these will be evaluated in order the first valid one
16623 # will be used to set origin identity. If none of these methods pass, the
16624 # request will be rejected with authentication failed error (401). Leave the
16625 # list empty if origin authentication is not required.
16626 { # [Deprecated] Configuration for the origin authentication method.
16627 # Configuration for the origin authentication method.
16628 &quot;jwt&quot;: { # [Deprecated] JWT configuration for origin authentication.
16629 # JWT configuration for origin authentication.
16630 &quot;audiences&quot;: [ # A JWT containing any of these audiences will be accepted. The service name
16631 # will be accepted if audiences is empty.
16632 # Examples: bookstore_android.apps.googleusercontent.com,
16633 # bookstore_web.apps.googleusercontent.com
16634 &quot;A String&quot;,
16635 ],
16636 &quot;issuer&quot;: &quot;A String&quot;, # Identifies the issuer that issued the JWT, which is usually a URL or an
16637 # email address.
16638 # Examples: https://securetoken.google.com,
16639 # [email protected]
16640 &quot;jwksPublicKeys&quot;: &quot;A String&quot;, # The provider&#x27;s public key set to validate the signature of the JWT.
16641 &quot;jwtHeaders&quot;: [ # jwt_headers and jwt_params define where to extract the JWT from an HTTP
16642 # request. If no explicit location is specified, the following default
16643 # locations are tried in order:
16644 #
16645 # 1. The Authorization header using the Bearer schema. See `here
16646 # `_. Example:
16647 #
16648 # Authorization: Bearer .
16649 #
16650 # 2. `access_token` query parameter. See `this
16651 # `_
16652 #
16653 # Multiple JWTs can be verified for a request. Each JWT has to be extracted
16654 # from the locations its issuer specified or from the default locations.
16655 #
16656 # This field is set if JWT is sent in a request header. This field specifies
16657 # the header name. For example, if `header=x-goog-iap-jwt-assertion`, the
16658 # header format will be x-goog-iap-jwt-assertion: .
16659 { # [Deprecated] This message specifies a header location to extract JWT token.
16660 # This message specifies a header location to extract JWT token.
16661 &quot;name&quot;: &quot;A String&quot;, # The HTTP header name.
16662 &quot;valuePrefix&quot;: &quot;A String&quot;, # The value prefix. The value format is &quot;value_prefix&quot;
16663 # For example, for &quot;Authorization: Bearer &quot;, value_prefix=&quot;Bearer &quot;
16664 # with a space at the end.
16665 },
16666 ],
16667 &quot;jwtParams&quot;: [ # This field is set if JWT is sent in a query parameter. This field specifies
16668 # the query parameter name. For example, if jwt_params[0] is jwt_token, the
16669 # JWT format in the query parameter is /path?jwt_token=.
16670 &quot;A String&quot;,
16671 ],
16672 },
16673 },
16674 ],
16675 &quot;peers&quot;: [ # List of authentication methods that can be used for peer authentication.
16676 # They will be evaluated in order the first valid one will be used to set
16677 # peer identity. If none of these methods pass, the request will be rejected
16678 # with authentication failed error (401). Leave the list empty if peer
16679 # authentication is not required.
16680 { # [Deprecated] Configuration for the peer authentication method.
16681 # Configuration for the peer authentication method.
16682 &quot;mtls&quot;: { # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Set if mTLS is used for peer authentication.
16683 # Configuration for the mutual Tls mode for peer authentication.
16684 &quot;mode&quot;: &quot;A String&quot;, # Specifies if the server TLS is configured to be strict or permissive. This
16685 # field can be set to one of the following:
16686 # STRICT: Client certificate must be presented, connection is in TLS.
16687 # PERMISSIVE: Client certificate can be omitted, connection can be either
16688 # plaintext or TLS.
16689 },
16690 },
16691 ],
16692 &quot;principalBinding&quot;: &quot;A String&quot;, # Define whether peer or origin identity should be used for principal.
16693 # Default value is USE_PEER. If peer (or origin) identity is not available,
16694 # either because peer/origin authentication is not defined, or failed,
16695 # principal will be left unset. In other words, binding rule does not affect
16696 # the decision to accept or reject request. This field can be set to one of
16697 # the following:
16698 # USE_PEER: Principal will be set to the identity from peer authentication.
16699 # USE_ORIGIN: Principal will be set to the identity from origin
16700 # authentication.
16701 &quot;serverTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain server-side security certificates and
16702 # identity information.
16703 # The TLS settings for the client or server.
16704 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
16705 # certificate.
16706 # Defines the mechanism to obtain the client or server certificate.
16707 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
16708 # applicable only if tlsCertificateSource is set to USE_PATH.
16709 # The paths to the mounted TLS Certificates and private key.
16710 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
16711 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
16712 },
16713 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
16714 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
16715 # is applicable only if tlsCertificateSource is set to USE_SDS.
16716 # The configuration to access the SDS server.
16717 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
16718 # gRPC config to access the SDS server.
16719 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
16720 # gRPC call credentials to access the SDS server.
16721 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
16722 # This field can be set to one of the following:
16723 #
16724 # - GCE_VM: The local GCE VM service account credentials are used to access
16725 # the SDS server.
16726 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
16727 # SDS server.
16728 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
16729 # FROM_PLUGIN.
16730 # Custom authenticator credentials.
16731 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
16732 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
16733 # plugin.
16734 },
16735 },
16736 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
16737 # gRPC channel credentials to access the SDS server.
16738 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
16739 # The paths to the mounted TLS Certificates and private key.
16740 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
16741 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
16742 },
16743 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
16744 # to one of the following:
16745 # CERTIFICATES: Use TLS certificates to access the SDS server.
16746 # GCE_VM: Use local GCE VM credentials to access the SDS server.
16747 },
16748 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
16749 },
16750 },
16751 },
16752 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
16753 # validate the client/server certificate. If omitted, the proxy will not
16754 # validate the server or client certificate.
16755 # certificate to validate the client/server certificate.
16756 # validate the client/server certificate.
16757 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
16758 # client or server certificate.
16759 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
16760 # is applicable only if tlsCertificateSource is set to USE_SDS.
16761 # The configuration to access the SDS server.
16762 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
16763 # gRPC config to access the SDS server.
16764 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
16765 # gRPC call credentials to access the SDS server.
16766 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
16767 # This field can be set to one of the following:
16768 #
16769 # - GCE_VM: The local GCE VM service account credentials are used to access
16770 # the SDS server.
16771 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
16772 # SDS server.
16773 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
16774 # FROM_PLUGIN.
16775 # Custom authenticator credentials.
16776 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
16777 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
16778 # plugin.
16779 },
16780 },
16781 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
16782 # gRPC channel credentials to access the SDS server.
16783 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
16784 # The paths to the mounted TLS Certificates and private key.
16785 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
16786 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
16787 },
16788 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
16789 # to one of the following:
16790 # CERTIFICATES: Use TLS certificates to access the SDS server.
16791 # GCE_VM: Use local GCE VM credentials to access the SDS server.
16792 },
16793 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
16794 },
16795 },
16796 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
16797 },
16798 },
16799 },
16800 &quot;authorizationConfig&quot;: { # [Deprecated] Authorization configuration provides service-level and # [Deprecated] Authorization config defines the Role Based Access Control
16801 # (RBAC) config.
16802 # Authorization config defines the Role Based Access Control (RBAC) config.
16803 # method-level access control for a service.
16804 # control for a service.
16805 &quot;policies&quot;: [ # List of RbacPolicies.
16806 {
16807 &quot;name&quot;: &quot;A String&quot;, # Name of the RbacPolicy.
16808 &quot;permissions&quot;: [ # The list of permissions.
16809 { # [Deprecated] All fields defined in a permission are ANDed.
16810 &quot;constraints&quot;: [ # Extra custom constraints. The constraints are ANDed together.
16811 { # Custom constraint that specifies a key and a list of allowed values for
16812 # Istio attributes.
16813 &quot;key&quot;: &quot;A String&quot;, # Key of the constraint.
16814 &quot;values&quot;: [ # A list of allowed values.
16815 &quot;A String&quot;,
16816 ],
16817 },
16818 ],
16819 &quot;hosts&quot;: [ # Used in Ingress or Egress Gateway cases to specify hosts that the policy
16820 # applies to. Exact match, prefix match, and suffix match are supported.
16821 &quot;A String&quot;,
16822 ],
16823 &quot;methods&quot;: [ # HTTP method.
16824 &quot;A String&quot;,
16825 ],
16826 &quot;notHosts&quot;: [ # Negate of hosts. Specifies exclusions.
16827 &quot;A String&quot;,
16828 ],
16829 &quot;notMethods&quot;: [ # Negate of methods. Specifies exclusions.
16830 &quot;A String&quot;,
16831 ],
16832 &quot;notPaths&quot;: [ # Negate of paths. Specifies exclusions.
16833 &quot;A String&quot;,
16834 ],
16835 &quot;notPorts&quot;: [ # Negate of ports. Specifies exclusions.
16836 &quot;A String&quot;,
16837 ],
16838 &quot;paths&quot;: [ # HTTP request paths or gRPC methods.
16839 # Exact match, prefix match, and suffix match are supported.
16840 &quot;A String&quot;,
16841 ],
16842 &quot;ports&quot;: [ # Port names or numbers.
16843 &quot;A String&quot;,
16844 ],
16845 },
16846 ],
16847 &quot;principals&quot;: [ # The list of principals.
16848 { # [Deprecated] All fields defined in a principal are ANDed.
16849 &quot;condition&quot;: &quot;A String&quot;, # An expression to specify custom condition.
16850 &quot;groups&quot;: [ # The groups the principal belongs to.
16851 # Exact match, prefix match, and suffix match are supported.
16852 &quot;A String&quot;,
16853 ],
16854 &quot;ips&quot;: [ # IPv4 or IPv6 address or range (In CIDR format)
16855 &quot;A String&quot;,
16856 ],
16857 &quot;namespaces&quot;: [ # The namespaces. Exact match, prefix match, and suffix match are supported.
16858 &quot;A String&quot;,
16859 ],
16860 &quot;notGroups&quot;: [ # Negate of groups. Specifies exclusions.
16861 &quot;A String&quot;,
16862 ],
16863 &quot;notIps&quot;: [ # Negate of IPs. Specifies exclusions.
16864 &quot;A String&quot;,
16865 ],
16866 &quot;notNamespaces&quot;: [ # Negate of namespaces. Specifies exclusions.
16867 &quot;A String&quot;,
16868 ],
16869 &quot;notUsers&quot;: [ # Negate of users. Specifies exclusions.
16870 &quot;A String&quot;,
16871 ],
16872 &quot;properties&quot;: { # A map of Istio attribute to expected values. Exact match, prefix match, and
16873 # suffix match are supported for values. For example,
16874 # `request.headers[version]: &quot;v1&quot;`. The properties are ANDed together.
16875 &quot;a_key&quot;: &quot;A String&quot;,
16876 },
16877 &quot;users&quot;: [ # The user names/IDs or service accounts.
16878 # Exact match, prefix match, and suffix match are supported.
16879 &quot;A String&quot;,
16880 ],
16881 },
16882 ],
16883 },
16884 ],
16885 },
16886 &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
16887 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
16888 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
16889 # private storage buckets that support Signature Version 4 for authentication.
16890 # The service name for generating the authentication header will always default
16891 # to &#x27;s3&#x27;.
16892 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
16893 # creating a backend that uses AWS v4 signature authentication, but will not
16894 # be returned as part of the configuration when queried with a REST API GET
16895 # request.
16896 #
16897 # @InputOnly
16898 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
16899 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
16900 # keep track of different iterations of your access key.
16901 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
16902 # the name of the region your cloud uses to host your origin. For example,
16903 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
16904 },
16905 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
16906 # that describes how clients should authenticate with this service&#x27;s
16907 # backends.
16908 #
16909 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
16910 # to INTERNAL_SELF_MANAGED.
16911 #
16912 # If left blank, communications are not encrypted.
16913 &quot;clientTlsSettings&quot;: { # [Deprecated] The client side authentication settings for connection # [Deprecated] TLS Settings for the backend service.
16914 # originating from the backend service.
16915 # the backend service.
16916 &quot;clientTlsContext&quot;: { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain client-side security certificates and
16917 # identity information. This field is only applicable when mode is set to
16918 # MUTUAL.
16919 # The TLS settings for the client or server.
16920 &quot;certificateContext&quot;: { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
16921 # certificate.
16922 # Defines the mechanism to obtain the client or server certificate.
16923 &quot;certificatePaths&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
16924 # applicable only if tlsCertificateSource is set to USE_PATH.
16925 # The paths to the mounted TLS Certificates and private key.
16926 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
16927 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
16928 },
16929 &quot;certificateSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
16930 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
16931 # is applicable only if tlsCertificateSource is set to USE_SDS.
16932 # The configuration to access the SDS server.
16933 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
16934 # gRPC config to access the SDS server.
16935 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
16936 # gRPC call credentials to access the SDS server.
16937 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
16938 # This field can be set to one of the following:
16939 #
16940 # - GCE_VM: The local GCE VM service account credentials are used to access
16941 # the SDS server.
16942 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
16943 # SDS server.
16944 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
16945 # FROM_PLUGIN.
16946 # Custom authenticator credentials.
16947 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
16948 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
16949 # plugin.
16950 },
16951 },
16952 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
16953 # gRPC channel credentials to access the SDS server.
16954 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
16955 # The paths to the mounted TLS Certificates and private key.
16956 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
16957 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
16958 },
16959 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
16960 # to one of the following:
16961 # CERTIFICATES: Use TLS certificates to access the SDS server.
16962 # GCE_VM: Use local GCE VM credentials to access the SDS server.
16963 },
16964 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
16965 },
16966 },
16967 },
16968 &quot;validationContext&quot;: { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
16969 # validate the client/server certificate. If omitted, the proxy will not
16970 # validate the server or client certificate.
16971 # certificate to validate the client/server certificate.
16972 # validate the client/server certificate.
16973 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the CA certificate to validate the
16974 # client or server certificate.
16975 &quot;sdsConfig&quot;: { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
16976 # is applicable only if tlsCertificateSource is set to USE_SDS.
16977 # The configuration to access the SDS server.
16978 &quot;grpcServiceConfig&quot;: { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
16979 # gRPC config to access the SDS server.
16980 &quot;callCredentials&quot;: { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
16981 # gRPC call credentials to access the SDS server.
16982 &quot;callCredentialType&quot;: &quot;A String&quot;, # The type of call credentials to use for GRPC requests to the SDS server.
16983 # This field can be set to one of the following:
16984 #
16985 # - GCE_VM: The local GCE VM service account credentials are used to access
16986 # the SDS server.
16987 # - FROM_PLUGIN: Custom authenticator credentials are used to access the
16988 # SDS server.
16989 &quot;fromPlugin&quot;: { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
16990 # FROM_PLUGIN.
16991 # Custom authenticator credentials.
16992 &quot;name&quot;: &quot;A String&quot;, # Plugin name.
16993 &quot;structConfig&quot;: &quot;A String&quot;, # A text proto that conforms to a Struct type definition interpreted by the
16994 # plugin.
16995 },
16996 },
16997 &quot;channelCredentials&quot;: { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
16998 # gRPC channel credentials to access the SDS server.
16999 &quot;certificates&quot;: { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
17000 # The paths to the mounted TLS Certificates and private key.
17001 &quot;certificatePath&quot;: &quot;A String&quot;, # The path to the file holding the client or server TLS certificate to use.
17002 &quot;privateKeyPath&quot;: &quot;A String&quot;, # The path to the file holding the client or server private key.
17003 },
17004 &quot;channelCredentialType&quot;: &quot;A String&quot;, # The channel credentials to access the SDS server. This field can be set
17005 # to one of the following:
17006 # CERTIFICATES: Use TLS certificates to access the SDS server.
17007 # GCE_VM: Use local GCE VM credentials to access the SDS server.
17008 },
17009 &quot;targetUri&quot;: &quot;A String&quot;, # The target URI of the SDS server.
17010 },
17011 },
17012 &quot;validationSource&quot;: &quot;A String&quot;, # Defines how TLS certificates are obtained.
17013 },
17014 },
17015 &quot;mode&quot;: &quot;A String&quot;, # Indicates whether connections to this port should be secured using TLS.
17016 # The value of this field determines how TLS is enforced. This can be set
17017 # to one of the following values: DISABLE: Do not setup a TLS connection to
17018 # the backends.
17019 # SIMPLE: Originate a TLS connection to the backends.
17020 # MUTUAL: Secure connections to the backends using mutual TLS by presenting
17021 # client certificates for authentication.
17022 &quot;sni&quot;: &quot;A String&quot;, # SNI string to present to the server during TLS handshake. This field is
17023 # applicable only when mode is SIMPLE or MUTUAL.
17024 &quot;subjectAltNames&quot;: [ # A list of alternate names to verify the subject identity in the
17025 # certificate.If specified,
17026 # the proxy will verify that the server certificate&#x27;s subject alt name
17027 # matches one of the specified values. This field is applicable only when
17028 # mode is SIMPLE or MUTUAL.
17029 &quot;A String&quot;,
17030 ],
17031 },
17032 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
17033 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
17034 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
17035 # specified values, the communication continues. Otherwise, it fails. This
17036 # additional check enables the client to verify that the server is authorized
17037 # to run the requested service.
17038 #
17039 # Note that the contents of the server
17040 # certificate&#x27;s subjectAltName field are configured by the
17041 # Public Key Infrastructure which provisions server identities.
17042 #
17043 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
17044 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
17045 # mode).
17046 &quot;A String&quot;,
17047 ],
17048 },
17049 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17050 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
17051 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
17052 #
17053 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
17054 # If set, lists of backends and health checks must be both empty.
17055 &quot;A String&quot;,
17056 ],
17057 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
17058 #
17059 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
17060 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
17061 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
17062 #
17063 # Only NONE and HEADER_FIELD are supported
17064 # when the backend service is referenced by a URL map that is bound to
17065 # target gRPC proxy that has validateForProxyless field set to true.
17066 #
17067 # For more details, see:
17068 # [Session
17069 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
17070 #
17071 # sessionAffinity cannot be specified with haPolicy.
17072 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
17073 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
17074 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
17075 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
17076 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
17077 # as a count of seconds and fractions of seconds at nanosecond
17078 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
17079 # or &quot;month&quot;. Range is approximately 10,000 years.
17080 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
17081 # Durations less than one second are represented with a 0
17082 # `seconds` field and a positive `nanos` field. Must be from 0
17083 # to 999,999,999 inclusive.
17084 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
17085 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
17086 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
17087 },
17088 },
17089 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
17090 # Currently this is applicable only for Internal TCP/UDP load balancing,
17091 # Internal HTTP(S) load balancing and Traffic Director.
17092 &quot;policy&quot;: &quot;A String&quot;,
17093 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
17094 # each service mesh client.
17095 #
17096 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
17097 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
17098 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
17099 # `INTERNAL_SELF_MANAGED`.
17100 #
17101 # `subset_size` is optional for Internal HTTP(S) load balancing
17102 # and required for Traffic Director.
17103 #
17104 # If you do not provide this value, Cloud Load Balancing will calculate it
17105 # dynamically to optimize the number of proxies/clients visible to each
17106 # backend and vice versa.
17107 #
17108 # Must be greater than 0. If `subset_size` is larger than the number of
17109 # backends/endpoints, then subsetting is disabled.
17110 },
17111 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
17112 # type of load balancer. For more information see,
17113 # Backend service settings.
17114 # The default is 30 seconds.
17115 # The full range of timeout values allowed goes from 1
17116 # through 2,147,483,647 seconds.
17117 #
17118 # This value can be overridden in the PathMatcher configuration of the
17119 # UrlMap that references this backend service.
17120 #
17121 # Not supported when the backend service is referenced by a URL map that is
17122 # bound to target gRPC proxy that has validateForProxyless field set to true.
17123 # Instead, use maxStreamDuration.
17124 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
17125 # when the backend protocol is SSL, HTTPS or HTTP2.
17126 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
17127 # networksecurity.googleapis.com namespace. Can be used in authenticating
17128 # TLS connections to the backend, as specified by the authenticationMode
17129 # field. Can only be specified if authenticationMode is not NONE.
17130 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
17131 #
17132 #
17133 # Use this property to configure the load balancer back-end to use
17134 # certificates and roots of trust provisioned by the Managed Workload
17135 # Identity system.
17136 #
17137 # The `identity` property is the
17138 # fully-specified SPIFFE ID to use in the SVID presented by the Load
17139 # Balancer Workload.
17140 #
17141 # The SPIFFE ID must be a resource starting with the
17142 # `trustDomain` property value, followed by the path to the Managed
17143 # Workload Identity.
17144 #
17145 # Supported SPIFFE ID format:
17146 #
17147 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
17148 #
17149 #
17150 # The Trust Domain within the Managed Identity must refer to a valid
17151 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
17152 # will be inherited from the Workload Identity Pool.
17153 #
17154 # Restrictions:
17155 #
17156 # - If you set the `identity` property, you cannot manually set
17157 # the following fields:
17158 # - tlsSettings.sni
17159 # - tlsSettings.subjectAltNames
17160 # - tlsSettings.authenticationConfig
17161 #
17162 #
17163 # When defining a `identity` for a RegionBackendServices, the
17164 # corresponding Workload Identity Pool must have a ca_pool
17165 # configured in the same region.
17166 #
17167 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
17168 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
17169 # balancer sends this string as the SNI hostname in the TLS connection to
17170 # the backend, and requires that this string match a Subject Alternative
17171 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
17172 # NEG backend, if the SNI is specified here, the load balancer uses it
17173 # regardless of whether the Regional Internet NEG is specified with FQDN or
17174 # IP address and port. When both sni and subjectAltNames[] are specified,
17175 # the load balancer matches the backend certificate&#x27;s SAN only to
17176 # subjectAltNames[].
17177 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
17178 # verifies during a TLS handshake with the backend. When the server
17179 # presents its X.509 certificate to the Load Balancer, the Load Balancer
17180 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
17181 # match one of the subjectAltNames in the list. This field is limited to 5
17182 # entries. When both sni and subjectAltNames[] are specified, the load
17183 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
17184 { # A Subject Alternative Name that the load balancer matches against the SAN
17185 # field in the TLS certificate provided by the backend, specified as either
17186 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
17187 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
17188 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
17189 },
17190 ],
17191 },
17192 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
17193 {
17194 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
17195 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
17196 # and ForwardingRule.
17197 },
17198 ],
17199 }
17200
17201 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17202 that if you must retry your request, the server will know to ignore the
17203 request if it has already been completed.
17204
17205 For example, consider a situation where you make an initial request and
17206 the request times out. If you make the request again with the same
17207 request ID, the server can check if original operation with the same
17208 request ID was received, and if so, will ignore the second request. This
17209 prevents clients from accidentally creating duplicate commitments.
17210
17211 The request ID must be
17212 a valid UUID with the exception that zero UUID is not supported
17213 (00000000-0000-0000-0000-000000000000).
17214 x__xgafv: string, V1 error format.
17215 Allowed values
17216 1 - v1 error format
17217 2 - v2 error format
17218
17219 Returns:
17220 An object of the form:
17221
17222 { # Represents an Operation resource.
17223 #
17224 # Google Compute Engine has three Operation resources:
17225 #
17226 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
17227 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
17228 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
17229 #
17230 # You can use an operation resource to manage asynchronous API requests.
17231 # For more information, readHandling
17232 # API responses.
17233 #
17234 # Operations can be global, regional or zonal.
17235 #
17236 # - For global operations, use the `globalOperations`
17237 # resource.
17238 # - For regional operations, use the
17239 # `regionOperations` resource.
17240 # - For zonal operations, use
17241 # the `zoneOperations` resource.
17242 #
17243 #
17244 #
17245 # For more information, read
17246 # Global, Regional, and Zonal Resources.
17247 #
17248 # Note that completed Operation resources have a limited
17249 # retention period.
17250 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17251 # Not present otherwise.
17252 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17253 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17254 # set when the operation is created.
17255 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17256 # text format.
17257 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17258 # this field will be populated.
17259 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17260 # operation.
17261 {
17262 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17263 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17264 # details. There is a set of defined message types to use for providing
17265 # details.The syntax depends on the error code. For example,
17266 # QuotaExceededInfo will have details when the error code is
17267 # QUOTA_EXCEEDED.
17268 {
17269 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17270 #
17271 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17272 # is not enabled:
17273 #
17274 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17275 # &quot;domain&quot;: &quot;googleapis.com&quot;
17276 # &quot;metadata&quot;: {
17277 # &quot;resource&quot;: &quot;projects/123&quot;,
17278 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17279 # }
17280 # }
17281 #
17282 # This response indicates that the pubsub.googleapis.com API is not enabled.
17283 #
17284 # Example of an error that is returned when attempting to create a Spanner
17285 # instance in a region that is out of stock:
17286 #
17287 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17288 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17289 # &quot;metadata&quot;: {
17290 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17291 # }
17292 # }
17293 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17294 # is typically the registered service name of the tool or product that
17295 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17296 # generated by some common infrastructure, the error domain must be a
17297 # globally unique value that identifies the infrastructure. For Google API
17298 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17299 &quot;metadatas&quot;: { # Additional structured details about this error.
17300 #
17301 # Keys must match a regular expression of `a-z+` but should
17302 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17303 # length. When identifying the current value of an exceeded limit, the units
17304 # should be contained in the key, not the value. For example, rather than
17305 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17306 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17307 # instances that can be created in a single (batch) request.
17308 &quot;a_key&quot;: &quot;A String&quot;,
17309 },
17310 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17311 # proximate cause of the error. Error reasons are unique within a particular
17312 # domain of errors. This should be at most 63 characters and match a
17313 # regular expression of `A-Z+[A-Z0-9]`, which represents
17314 # UPPER_SNAKE_CASE.
17315 },
17316 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17317 #
17318 # For example, if a quota check failed with an error indicating the calling
17319 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17320 # directly to the right place in the developer console to flip the bit.
17321 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17322 { # Describes a URL link.
17323 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17324 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17325 },
17326 ],
17327 },
17328 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17329 # which can be attached to an RPC error.
17330 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17331 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17332 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17333 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17334 },
17335 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17336 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17337 &quot;a_key&quot;: &quot;A String&quot;,
17338 },
17339 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17340 # type or metric.
17341 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17342 # or metric.
17343 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17344 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17345 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17346 },
17347 },
17348 ],
17349 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17350 # This property is optional.
17351 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17352 },
17353 ],
17354 },
17355 &quot;getVersionOperationMetadata&quot;: {
17356 &quot;inlineSbomInfo&quot;: {
17357 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17358 # appropriate identifiers.
17359 &quot;a_key&quot;: &quot;A String&quot;,
17360 },
17361 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17362 # identifiers.
17363 &quot;a_key&quot;: &quot;A String&quot;,
17364 },
17365 },
17366 },
17367 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17368 # message that was returned, such as `NOT FOUND`.
17369 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17370 # status code that was returned. For example, a `404` means the
17371 # resource was not found.
17372 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17373 # defined by the server.
17374 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17375 # This value is inRFC3339
17376 # text format.
17377 &quot;instancesBulkInsertOperationMetadata&quot;: {
17378 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17379 # Example key: zones/us-central1-a
17380 &quot;a_key&quot;: {
17381 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17382 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17383 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17384 # error.
17385 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17386 # if the flow is rolling forward or rolling back.
17387 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17388 },
17389 },
17390 },
17391 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17392 # Operation resources.
17393 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17394 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17395 # group of operations results from a `bulkInsert` API request.
17396 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17397 # `update`, or `delete`, and so on.
17398 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17399 # There is no requirement that this be linear or support any granularity of
17400 # operations. This should not be used to guess when the operation will be
17401 # complete. This number should monotonically increase as the operation
17402 # progresses.
17403 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17404 # applicable when performing regional operations.
17405 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17406 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
17407 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17408 # this field will contain information on all underlying zonal actions and
17409 # their state.
17410 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17411 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17412 # Example key: zones/us-central1-a
17413 &quot;a_key&quot;: {
17414 &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
17415 # populated.
17416 # different programming environments, including REST APIs and RPC APIs. It is
17417 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17418 # three pieces of data: error code, error message, and error details.
17419 #
17420 # You can find out more about this error model and how to work with it in the
17421 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17422 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17423 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17424 # message types for APIs to use.
17425 {
17426 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17427 },
17428 ],
17429 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17430 # user-facing error message should be localized and sent in the
17431 # google.rpc.Status.details field, or localized by the client.
17432 },
17433 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17434 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17435 },
17436 },
17437 },
17438 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17439 # This value is inRFC3339
17440 # text format.
17441 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17442 # following:
17443 # `PENDING`, `RUNNING`, or `DONE`.
17444 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17445 # operation.
17446 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17447 # of the target resource.
17448 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17449 # operations related to creating a snapshot, this points to the disk
17450 # that the snapshot was created from.
17451 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17452 # `[email protected]` or
17453 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17454 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17455 # operation, this field will be populated.
17456 {
17457 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17458 # Engine returns NO_RESULTS_ON_PAGE if there
17459 # are no results in the response.
17460 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17461 # value format. For example:
17462 #
17463 # &quot;data&quot;: [
17464 # {
17465 # &quot;key&quot;: &quot;scope&quot;,
17466 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17467 # }
17468 {
17469 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17470 # returned. For example, for warnings where there are no results in a list
17471 # request for a particular zone, this key might be scope and
17472 # the key value might be the zone name. Other examples might be a key
17473 # indicating a deprecated resource and a suggested replacement, or a
17474 # warning about invalid network settings (for example, if an instance
17475 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17476 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17477 },
17478 ],
17479 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17480 },
17481 ],
17482 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17483 # applicable when performing per-zone operations.
17484 }</pre>
17485 </div>
17486
17487 </body></html>