Debian Codegraph @

docs/dyn/compute_beta.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_beta.html">Compute Engine API</a> . <a href="compute_beta.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/beta/globalOperations)
190 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
191 # * [Zonal](/compute/docs/reference/rest/beta/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;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
370 # this field will contain information on all underlying zonal actions and
371 # their state.
372 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
373 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
374 # Example key: zones/us-central1-a
375 &quot;a_key&quot;: {
376 &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
377 # populated.
378 # different programming environments, including REST APIs and RPC APIs. It is
379 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
380 # three pieces of data: error code, error message, and error details.
381 #
382 # You can find out more about this error model and how to work with it in the
383 # [API Design Guide](https://cloud.google.com/apis/design/errors).
384 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
385 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
386 # message types for APIs to use.
387 {
388 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
389 },
390 ],
391 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
392 # user-facing error message should be localized and sent in the
393 # google.rpc.Status.details field, or localized by the client.
394 },
395 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
396 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
397 },
398 },
399 },
400 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
401 # This value is inRFC3339
402 # text format.
403 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
404 # following:
405 # `PENDING`, `RUNNING`, or `DONE`.
406 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
407 # operation.
408 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
409 # of the target resource.
410 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
411 # operations related to creating a snapshot, this points to the disk
412 # that the snapshot was created from.
413 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
414 # `[email protected]` or
415 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
416 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
417 # operation, this field will be populated.
418 {
419 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
420 # Engine returns NO_RESULTS_ON_PAGE if there
421 # are no results in the response.
422 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
423 # value format. For example:
424 #
425 # &quot;data&quot;: [
426 # {
427 # &quot;key&quot;: &quot;scope&quot;,
428 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
429 # }
430 {
431 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
432 # returned. For example, for warnings where there are no results in a list
433 # request for a particular zone, this key might be scope and
434 # the key value might be the zone name. Other examples might be a key
435 # indicating a deprecated resource and a suggested replacement, or a
436 # warning about invalid network settings (for example, if an instance
437 # attempts to perform IP forwarding but is not enabled for IP forwarding).
438 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
439 },
440 ],
441 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
442 },
443 ],
444 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
445 # applicable when performing per-zone operations.
446 }</pre>
447 </div>
448
449 <div class="method">
450 <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>
451 <pre>Retrieves the list of all BackendService resources, regional and global,
452 available to the specified project.
453
454 To prevent failure, it is recommended that you set the
455 `returnPartialSuccess` parameter to `true`.
456
457 Args:
458 project: string, Name of the project scoping this request. (required)
459 filter: string, A filter expression that filters resources listed in the response. Most
460 Compute resources support two types of filter expressions:
461 expressions that support regular expressions and expressions that follow
462 API improvement proposal AIP-160.
463 These two types of filter expressions cannot be mixed in one request.
464
465 If you want to use AIP-160, your expression must specify the field name, an
466 operator, and the value that you want to use for filtering. The value
467 must be a string, a number, or a boolean. The operator
468 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
469
470 For example, if you are filtering Compute Engine instances, you can
471 exclude instances named `example-instance` by specifying
472 `name != example-instance`.
473
474 The `:*` comparison can be used to test whether a key has been defined.
475 For example, to find all objects with `owner` label use:
476 ```
477 labels.owner:*
478 ```
479
480 You can also filter nested fields. For example, you could specify
481 `scheduling.automaticRestart = false` to include instances only
482 if they are not scheduled for automatic restarts. You can use filtering
483 on nested fields to filter based onresource labels.
484
485 To filter on multiple expressions, provide each separate expression within
486 parentheses. For example:
487 ```
488 (scheduling.automaticRestart = true)
489 (cpuPlatform = &quot;Intel Skylake&quot;)
490 ```
491 By default, each expression is an `AND` expression. However, you
492 can include `AND` and `OR` expressions explicitly.
493 For example:
494 ```
495 (cpuPlatform = &quot;Intel Skylake&quot;) OR
496 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
497 (scheduling.automaticRestart = true)
498 ```
499
500 If you want to use a regular expression, use the `eq` (equal) or `ne`
501 (not equal) operator against a single un-parenthesized expression with or
502 without quotes or against multiple parenthesized expressions. Examples:
503
504 `fieldname eq unquoted literal`
505 `fieldname eq &#x27;single quoted literal&#x27;`
506 `fieldname eq &quot;double quoted literal&quot;`
507 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
508
509 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
510 The literal value must match the entire field.
511
512 For example, to filter for instances that do not end with name &quot;instance&quot;,
513 you would use `name ne .*instance`.
514
515 You cannot combine constraints on multiple fields using regular
516 expressions.
517 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
518 global) should be included in the response. For new resource types added
519 after this field, the flag has no effect as new resource types will always
520 include every visible scope for each scope type in response. For resource
521 types which predate this field, if this flag is omitted or false, only
522 scopes of the scope types where the resource type is expected to be found
523 will be included.
524 maxResults: integer, The maximum number of results per page that should be returned.
525 If the number of available results is larger than `maxResults`,
526 Compute Engine returns a `nextPageToken` that can be used to get
527 the next page of results in subsequent list requests. Acceptable values are
528 `0` to `500`, inclusive. (Default: `500`)
529 orderBy: string, Sorts list results by a certain order. By default, results
530 are returned in alphanumerical order based on the resource name.
531
532 You can also sort results in descending order based on the creation
533 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
534 results based on the `creationTimestamp` field in
535 reverse chronological order (newest result first). Use this to sort
536 resources like operations so that the newest operation is returned first.
537
538 Currently, only sorting by `name` or
539 `creationTimestamp desc` is supported.
540 pageToken: string, Specifies a page token to use. Set `pageToken` to the
541 `nextPageToken` returned by a previous list request to get
542 the next page of results.
543 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
544 of failure. The default value is false.
545
546 For example, when partial success behavior is enabled, aggregatedList for a
547 single zone scope either returns all resources in the zone or no resources,
548 with an error code.
549 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
550 aggregated list request is invoked for subnetworks list-usable api.
551 x__xgafv: string, V1 error format.
552 Allowed values
553 1 - v1 error format
554 2 - v2 error format
555
556 Returns:
557 An object of the form:
558
559 { # Contains a list of BackendServicesScopedList.
560 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
561 &quot;items&quot;: { # A list of BackendServicesScopedList resources.
562 &quot;a_key&quot;: { # Name of the scope containing this set of BackendServices.
563 &quot;backendServices&quot;: [ # A list of BackendServices contained in this scope.
564 { # Represents a Backend Service resource.
565 #
566 # A backend service defines how Google Cloud load balancers distribute traffic.
567 # The backend service configuration contains a set of values, such as the
568 # protocol used to connect to backends, various distribution and session
569 # settings, health checks, and timeouts. These settings provide fine-grained
570 # control over how your load balancer behaves. Most of the settings have
571 # default values that allow for easy configuration if you need to get started
572 # quickly.
573 #
574 # Backend services in Google Compute Engine can be either regionally or
575 # globally scoped.
576 #
577 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
578 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
579 #
580 # For more information, seeBackend
581 # Services.
582 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
583 # Load Balancers and Traffic Director and requires
584 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
585 #
586 # If set to 0, the cookie is non-persistent and lasts only until
587 # the end of the browser session (or equivalent). The maximum allowed value
588 # is two weeks (1,209,600).
589 #
590 # Not supported when the backend service is referenced by a URL map that is
591 # bound to target gRPC proxy that has validateForProxyless field set to true.
592 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
593 { # Message containing information of one individual backend.
594 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
595 # handle additional traffic or is fully loaded. For usage guidelines, see
596 # Connection balancing mode.
597 #
598 # Backends must use compatible balancing modes. For more information, see
599 # Supported balancing modes and target capacity settings and
600 # Restrictions and guidance for instance groups.
601 #
602 # Note: Currently, if you use the API to configure incompatible balancing
603 # modes, the configuration might be accepted even though it has no impact
604 # and is ignored. Specifically, Backend.maxUtilization is ignored when
605 # Backend.balancingMode is RATE. In the future, this incompatible combination
606 # will be rejected.
607 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
608 # mode.
609 # The default value is 1, which means the group serves up to
610 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
611 # completely drained, offering 0% of its available capacity. The valid ranges
612 # are 0.0 and [0.1,1.0].
613 # You cannot configure a setting larger than 0 and smaller than0.1.
614 # You cannot configure a setting of 0 when there is only one
615 # backend attached to the backend service.
616 #
617 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
618 # internet NEGs, regional serverless NEGs, and PSC NEGs.
619 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
620 # BalancingMode.
621 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
622 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
623 # Monitoring, but is not used for load balancing.
624 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
625 # balancing mode. The valid range is [0.0, 1.0].
626 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
627 # long and match the regular expression
628 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
629 # first character must be a lowercase letter, and all following
630 # characters must be a dash, period, underscore, lowercase letter, or
631 # digit, except the last character, which cannot be a dash, period, or
632 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
633 # field can only be used for a global or regional backend service with the
634 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
635 },
636 ],
637 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
638 # create the resource.
639 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
640 # failover backend can be configured for a given BackendService.
641 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
642 # group or network endpoint
643 # group (NEG) resource. To determine what types of backends a load
644 # balancer supports, see the [Backend services
645 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
646 #
647 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
648 # or NEG. Partial URLs are not supported.
649 #
650 # If haPolicy is specified, backends must refer to NEG resources of type
651 # GCE_VM_IP.
652 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
653 # guidelines, seeConnection
654 # balancing mode and Utilization
655 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
656 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
657 # guidelines, seeConnection
658 # balancing mode and Utilization
659 # balancing mode.
660 #
661 # Not available if the backend&#x27;s balancingMode isRATE.
662 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
663 # For usage guidelines, seeConnection
664 # balancing mode and Utilization
665 # balancing mode.
666 #
667 # Not available if the backend&#x27;s balancingMode isRATE.
668 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
669 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
670 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
671 # Not available if backend&#x27;s balancingMode is RATE
672 # or CONNECTION.
673 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
674 # Not available if backend&#x27;s balancingMode is RATE
675 # or CONNECTION.
676 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
677 # usage guidelines, seeRate
678 # balancing mode and Utilization
679 # balancing mode.
680 #
681 # Not available if the backend&#x27;s balancingMode isCONNECTION.
682 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
683 # guidelines, seeRate
684 # balancing mode and Utilization
685 # balancing mode.
686 #
687 # Not available if the backend&#x27;s balancingMode isCONNECTION.
688 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
689 # guidelines, seeRate
690 # balancing mode and Utilization
691 # balancing mode.
692 #
693 # Not available if the backend&#x27;s balancingMode isCONNECTION.
694 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
695 #
696 # For usage guidelines, seeUtilization
697 # balancing mode.
698 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
699 # the backend.
700 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
701 },
702 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
703 # sending traffic to backends with default preference. The possible values
704 # are:
705 #
706 # - PREFERRED: Backends with this preference level will be
707 # filled up to their capacity limits first, based on RTT.
708 # - DEFAULT: If preferred backends don&#x27;t have enough
709 # capacity, backends in this layer would be used and traffic would be
710 # assigned based on the load balancing algorithm you use. This is the
711 # default
712 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
713 # Attachment).
714 # e.g.
715 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
716 # for Cloud Run service.
717 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
718 # for PSC Service Attachment.
719 &quot;trafficDuration&quot;: &quot;A String&quot;,
720 },
721 ],
722 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
723 # specified load balancer types.
724 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
725 # Pragma or Authorization headers. Up to 5 headers can be specified.
726 # The cache is bypassed for all cdnPolicy.cacheMode settings.
727 { # Bypass the cache when the specified request headers are present,
728 # e.g. Pragma or Authorization headers. Values are case insensitive.
729 # The presence of such a header overrides the cache_mode setting.
730 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
731 # Values are case-insensitive.
732 },
733 ],
734 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
735 # CDN.
736 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
737 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
738 &quot;A String&quot;,
739 ],
740 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
741 # The name=value pair will be used in the cache key Cloud CDN generates.
742 &quot;A String&quot;,
743 ],
744 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
745 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
746 # query_string_whitelist and query_string_blacklist. If neither is set, the
747 # entire query string will be included. If false, the query string will be
748 # excluded from the cache key entirely.
749 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
750 # parameters will be included. Either specify query_string_whitelist or
751 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
752 # not treated as delimiters.
753 &quot;A String&quot;,
754 ],
755 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
756 # parameters will be excluded. Either specify query_string_whitelist or
757 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
758 # not treated as delimiters.
759 &quot;A String&quot;,
760 ],
761 },
762 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
763 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
764 # headers to cache content. Responses without these headers will not be
765 # cached at Google&#x27;s edge, and will require a full trip to the origin on
766 # every request, potentially impacting performance and increasing load on
767 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
768 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
769 # Warning: this may result in Cloud CDN caching private,
770 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
771 # including common image formats, media (video and audio), and web assets
772 # (JavaScript and CSS). Requests and responses that are marked as
773 # uncacheable, as well as dynamic content (including HTML), will not be
774 # cached.
775 #
776 # If no value is provided for cdnPolicy.cacheMode, it defaults
777 # to CACHE_ALL_STATIC.
778 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
779 # used to clamp the max-age (or Expires) value sent to the client. With
780 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
781 # response max-age directive, along with a &quot;public&quot; directive. For
782 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
783 # from the origin (if specified), or else sets the response max-age
784 # directive to the lesser of the client_ttl and default_ttl, and also
785 # ensures a &quot;public&quot; cache-control directive is present.
786 # If a client TTL is not specified, a default value (1 hour) will be used.
787 # The maximum allowed value is 31,622,400s (1 year).
788 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
789 # responses that do not have an existing valid TTL (max-age or s-maxage).
790 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
791 # The value of defaultTTL cannot be set to a value greater than that of
792 # maxTTL, but can be equal.
793 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
794 # will overwrite the TTL set in all responses. The maximum allowed value is
795 # 31,622,400s (1 year), noting that infrequently accessed objects may be
796 # evicted from the cache before the defined TTL.
797 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
798 # origin.
799 # Cache directives that attempt to set a max-age or s-maxage higher than
800 # this, or an Expires header more than maxTTL seconds in the future will
801 # be capped at the value of maxTTL, as if it were the value of an
802 # s-maxage Cache-Control directive.
803 # Headers sent to the client will not be modified.
804 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
805 # The maximum allowed value is 31,622,400s (1 year), noting that
806 # infrequently accessed objects may be evicted from the cache before
807 # the defined TTL.
808 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
809 # to apply fine-grained caching for common errors or redirects.
810 # This can reduce the load on your origin and improve end-user
811 # experience by reducing response latency.
812 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
813 # negative caching applies to responses with the specified response code
814 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
815 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
816 # to all responses with the specified response code, and override any
817 # caching headers.
818 # By default, Cloud CDN will apply the following default TTLs to these
819 # status codes:
820 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
821 # HTTP 404 (Not Found), 410 (Gone),
822 # 451 (Unavailable For Legal Reasons): 120s
823 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
824 # These defaults can be overridden in negative_caching_policy.
825 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
826 # negative_caching must be enabled to configure negative_caching_policy.
827 # Omitting the policy and leaving negative_caching enabled will use
828 # Cloud CDN&#x27;s default cache TTLs.
829 # Note that when specifying an explicit negative_caching_policy, you
830 # should take care to specify a cache TTL for all response codes
831 # that you wish to cache. Cloud CDN will not apply any default
832 # negative caching when a policy exists.
833 { # Specify CDN TTLs for response error codes.
834 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
835 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
836 # specified as values, and you cannot specify a status code more than
837 # once.
838 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
839 # corresponding status code.
840 # The maximum allowed value is 1800s (30 minutes), noting that
841 # infrequently accessed objects may be evicted from the cache before the
842 # defined TTL.
843 },
844 ],
845 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
846 # requests into a small number of requests to the origin.
847 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
848 # content with the origin, or when an error is encountered when refreshing
849 # the cache.
850 # This setting defines the default &quot;max-stale&quot; duration for any cached
851 # responses that do not specify a max-stale directive. Stale responses that
852 # exceed the TTL configured here will not be served. The default limit
853 # (max-stale) is 86400s (1 day), which will allow stale content to be
854 # served up to this limit beyond the max-age (or s-maxage) of a cached
855 # response.
856 # The maximum allowed value is 604800 (1 week).
857 # Set this to zero (0) to disable serve-while-stale.
858 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
859 # considered fresh. After this time period, the response will be
860 # revalidated before being served. Defaults to 1hr (3600s). When serving
861 # responses to signed URL requests, Cloud CDN will internally behave as
862 # though all responses from this backend had a &quot;Cache-Control:
863 # public, max-age=[TTL]&quot; header, regardless of any existing
864 # Cache-Control header. The actual headers served in responses will not be
865 # altered.
866 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
867 &quot;A String&quot;,
868 ],
869 },
870 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
871 # backend service.
872 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
873 # as a count of seconds and fractions of seconds at nanosecond
874 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
875 # or &quot;month&quot;. Range is approximately 10,000 years.
876 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
877 # Durations less than one second are represented with a 0
878 # `seconds` field and a positive `nanos` field. Must be from 0
879 # to 999,999,999 inclusive.
880 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
881 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
882 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
883 },
884 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
885 # there is no limit.
886 #
887 # Not supported when the backend service is referenced by a URL map that is
888 # bound to target gRPC proxy that has validateForProxyless field set to true.
889 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
890 # not specified, there is no limit.
891 #
892 # Not supported when the backend service is referenced by a URL map that is
893 # bound to target gRPC proxy that has validateForProxyless field set to true.
894 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
895 # service. If not specified, there is no limit.
896 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
897 # This parameter is respected by both the HTTP/1.1 and HTTP/2
898 # implementations. If not specified, there is no limit. Setting this
899 # parameter to 1 will effectively disable keep alive.
900 #
901 # Not supported when the backend service is referenced by a URL map that is
902 # bound to target gRPC proxy that has validateForProxyless field set to true.
903 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
904 # not specified, the default is 1.
905 #
906 # Not supported when the backend service is referenced by a URL map that is
907 # bound to target gRPC proxy that has validateForProxyless field set to true.
908 },
909 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
910 # the client&#x27;s Accept-Encoding header.
911 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
912 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
913 # instance. For supported load balancers and protocols, as described inEnabling
914 # connection draining.
915 },
916 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
917 # tracking policy settings are only available for external passthrough
918 # Network Load Balancers and internal passthrough Network Load Balancers.
919 #
920 # connectionTrackingPolicy cannot be specified with haPolicy.
921 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
922 # value is DEFAULT_FOR_PROTOCOL.
923 #
924 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
925 # persist on unhealthy backends only for connection-oriented protocols
926 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
927 # Affinity is configured for 5-tuple. They do not persist forUDP.
928 #
929 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
930 # the existing connections on the unhealthy backend are never persisted on
931 # the unhealthy backend. They are always diverted to newly selected healthy
932 # backends (unless all backends are unhealthy).
933 #
934 # If set to ALWAYS_PERSIST, existing connections always
935 # persist on unhealthy backends regardless of protocol and session
936 # affinity. It is generally not recommended to use this mode overriding the
937 # default.
938 #
939 # For more details, see [Connection Persistence for Network Load
940 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
941 # and [Connection Persistence for Internal TCP/UDP Load
942 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
943 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
944 # Balancers. This option is not available publicly.
945 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
946 # matching traffic (in seconds).
947 #
948 # For internal passthrough Network Load Balancers:
949 #
950 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
951 # - It can be set only if Connection Tracking is less than 5-tuple
952 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
953 # Mode is PER_SESSION).
954 #
955 #
956 #
957 # For external passthrough Network Load Balancers the default is 60
958 # seconds. This option is not available publicly.
959 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
960 # options:
961 #
962 # - PER_CONNECTION: This is the default mode. The Connection
963 # Tracking is performed as per the Connection Key (default Hash Method) for
964 # the specific protocol.
965 # - PER_SESSION: The Connection Tracking is performed as per
966 # the configured Session Affinity. It matches the configured Session
967 # Affinity.
968 #
969 #
970 #
971 # For more details, see [Tracking Mode for Network Load
972 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
973 # and [Tracking Mode for Internal TCP/UDP Load
974 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
975 },
976 &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
977 # affinity based on HTTP headers, cookies or other properties. This load
978 # balancing policy is applicable only for HTTP connections. The affinity to a
979 # particular destination host will be lost when one or more hosts are
980 # added/removed from the destination service. This field specifies parameters
981 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
982 #
983 # This field is applicable to either:
984 #
985 # - A regional backend service with the service protocol set to HTTP,
986 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
987 # INTERNAL_MANAGED.
988 # - A global backend service with the
989 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
990 &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
991 # be used as the hash key for the consistent hash load balancer. If the
992 # cookie is not present, it will be generated. This field is applicable if
993 # the sessionAffinity is set to HTTP_COOKIE.
994 #
995 # Not supported when the backend service is referenced by a URL map that is
996 # bound to target gRPC proxy that has validateForProxyless field set to true.
997 # for load balancing policies that use a consistent hash.
998 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
999 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
1000 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
1001 # as a count of seconds and fractions of seconds at nanosecond
1002 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1003 # or &quot;month&quot;. Range is approximately 10,000 years.
1004 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1005 # Durations less than one second are represented with a 0
1006 # `seconds` field and a positive `nanos` field. Must be from 0
1007 # to 999,999,999 inclusive.
1008 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1009 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1010 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1011 },
1012 },
1013 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
1014 # applicable if the sessionAffinity is set toHEADER_FIELD.
1015 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
1016 # 1024. Larger ring sizes result in more granular load distributions. If the
1017 # number of hosts in the load balancing pool is larger than the ring size,
1018 # each host will be assigned a single virtual node.
1019 },
1020 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1021 # text format.
1022 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
1023 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
1024 # locality_lb_policy.
1025 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
1026 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
1027 # long and match the regular expression
1028 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
1029 # first character must be a lowercase letter, and all following
1030 # characters must be a dash, period, underscore, lowercase letter, or
1031 # digit, except the last character, which cannot be a dash, period, or
1032 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
1033 # field can only be used for a global or regional backend service with the
1034 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
1035 },
1036 ],
1037 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
1038 # custom
1039 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
1040 &quot;A String&quot;,
1041 ],
1042 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
1043 # custom
1044 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
1045 &quot;A String&quot;,
1046 ],
1047 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1048 # create the resource.
1049 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
1050 # backend service with dynamic forwarding feature which together with Service
1051 # Extension allows customized and complex routing logic.
1052 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
1053 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
1054 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
1055 },
1056 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
1057 # service. Some ranges are restricted: Restricted
1058 # ranges.
1059 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
1060 },
1061 },
1062 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
1063 # this backend service.
1064 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
1065 # global external Application Load Balancer.
1066 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
1067 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
1068 #
1069 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
1070 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
1071 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
1072 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
1073 # externalManagedMigrationTestingPercentage.
1074 #
1075 # Rolling back a migration requires the states to be set in reverse order. So
1076 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
1077 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
1078 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
1079 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
1080 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
1081 # external Application Load Balancer.
1082 #
1083 # The value of this field must be in the range [0, 100].
1084 #
1085 # Session affinity options will slightly affect this routing behavior, for
1086 # more details, see:Session
1087 # Affinity.
1088 #
1089 # This value can only be set if the loadBalancingScheme in the BackendService
1090 # is set to EXTERNAL (when using the classic Application Load Balancer) and
1091 # the migration state is TEST_BY_PERCENTAGE.
1092 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
1093 # as a backup (failover) backend.
1094 # For load balancers that have configurable failover:
1095 # [Internal passthrough Network Load
1096 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1097 # and [external passthrough Network Load
1098 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1099 #
1100 # failoverPolicy cannot be specified with haPolicy.
1101 # failover:
1102 # [Internal passthrough Network Load
1103 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1104 # and [external passthrough
1105 # Network Load
1106 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1107 # On failover or failback, this field indicates whether connection draining
1108 # will be honored. Google Cloud has a fixed connection draining timeout of
1109 # 10 minutes. A setting of true terminates existing TCP
1110 # connections to the active pool during failover and failback, immediately
1111 # draining traffic. A setting of false allows existing TCP
1112 # connections to persist, even on VMs no longer in the active pool, for up
1113 # to the duration of the connection draining timeout (10 minutes).
1114 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
1115 #
1116 # The default is false.
1117 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
1118 # load balancer are dropped when all primary and all backup backend VMs are
1119 # unhealthy.If set to false, connections are distributed
1120 # among all primary VMs when all primary and all backup backend VMs are
1121 # unhealthy.
1122 # For load balancers that have configurable
1123 # failover:
1124 # [Internal passthrough
1125 # Network Load
1126 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1127 # and [external passthrough
1128 # Network Load
1129 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1130 # The default is false.
1131 &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
1132 # failover when the number of healthy primary VMs equals zero.
1133 # For all other values, the load balancer performs a failover when the
1134 # total number of healthy primary VMs is less than this ratio.
1135 # For load balancers that have configurable
1136 # failover:
1137 # [Internal TCP/UDP Load
1138 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1139 # and [external TCP/UDP Load
1140 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1141 },
1142 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1143 # This field is used in optimistic locking. This field will be ignored when
1144 # inserting a BackendService. An up-to-date fingerprint must be provided in
1145 # order to update the BackendService, otherwise the request will
1146 # fail with error 412 conditionNotMet.
1147 #
1148 # To see the latest fingerprint, make a get() request to
1149 # retrieve a BackendService.
1150 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
1151 # Protocol Forwarding.
1152 #
1153 # The backends of this regional backend service must only specify zonal
1154 # network endpoint groups (NEGs) of type GCE_VM_IP.
1155 #
1156 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
1157 # regional backend service must set the network field. All zonal NEGs must
1158 # belong to the same network. However, individual NEGs can
1159 # belong to different subnetworks of that network.
1160 #
1161 # When haPolicy is specified, the set of attached network endpoints across
1162 # all backends comprise an High Availability domain from which one endpoint
1163 # is selected as the active endpoint (the leader) that receives all
1164 # traffic.
1165 #
1166 # haPolicy can be added only at backend service creation time. Once set up,
1167 # it cannot be deleted.
1168 #
1169 # Note that haPolicy is not for load balancing, and therefore cannot be
1170 # specified with sessionAffinity, connectionTrackingPolicy, and
1171 # failoverPolicy.
1172 #
1173 # haPolicy requires customers to be responsible for tracking backend
1174 # endpoint health and electing a leader among the healthy endpoints.
1175 # Therefore, haPolicy cannot be specified with healthChecks.
1176 #
1177 # haPolicy can only be specified for External Passthrough Network Load
1178 # Balancers and Internal Passthrough Network Load Balancers.
1179 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
1180 # achieve it.
1181 #
1182 # Supported values are:
1183 #
1184 # - DISABLED: Fast IP Move is disabled. You can only use the
1185 # haPolicy.leader API to update the leader.
1186 # - &gt;GARP_RA: Provides a method to very quickly define a new network
1187 # endpoint as the leader. This method is faster than updating the leader
1188 # using the haPolicy.leader API. Fast IP move works as follows: The VM
1189 # hosting the network endpoint that should become the new leader sends
1190 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
1191 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
1192 # temporarily associates the forwarding rule IP address with that VM, and
1193 # both new and in-flight packets are quickly delivered to that VM.
1194 #
1195 #
1196 #
1197 # Note the important properties of the Fast IP Move functionality:
1198 #
1199 # - The GARP/RA-initiated re-routing stays active for approximately 20
1200 # minutes. After triggering fast failover, you must also
1201 # appropriately set the haPolicy.leader.
1202 # - The new leader instance should continue to send GARP/RA packets
1203 # periodically every 10 seconds until at least 10 minutes after updating
1204 # the haPolicy.leader (but stop immediately if it is no longer the leader).
1205 # - After triggering a fast failover, we recommend that you wait at least
1206 # 3 seconds before sending another GARP/RA packet from a different VM
1207 # instance to avoid race conditions.
1208 # - Don&#x27;t send GARP/RA packets from different VM
1209 # instances at the same time. If multiple instances continue to send
1210 # GARP/RA packets, traffic might be routed to different destinations in an
1211 # alternating order. This condition ceases when a single instance
1212 # issues a GARP/RA packet.
1213 # - The GARP/RA request always takes priority over the leader API.
1214 # Using the haPolicy.leader API to change the leader to a different
1215 # instance will have no effect until the GARP/RA request becomes
1216 # inactive.
1217 # - The GARP/RA packets should follow the GARP/RA
1218 # Packet Specifications..
1219 # - When multiple forwarding rules refer to a regional backend service,
1220 # you need only send a GARP or RA packet for a single forwarding rule
1221 # virtual IP. The virtual IPs for all forwarding rules targeting the same
1222 # backend service will also be moved to the sender of the GARP or RA
1223 # packet.
1224 #
1225 #
1226 #
1227 # The following are the Fast IP Move limitations (that is, when fastIPMove
1228 # is not DISABLED):
1229 #
1230 # - Multiple forwarding rules cannot use the same IP address if one of
1231 # them refers to a regional backend service with fastIPMove.
1232 # - The regional backend service must set the network field, and all
1233 # NEGs must belong to that network. However, individual
1234 # NEGs can belong to different subnetworks of that network.
1235 # - The maximum number of network endpoints across all backends of a
1236 # backend service with fastIPMove is 32.
1237 # - The maximum number of backend services with fastIPMove that can have
1238 # the same network endpoint attached to one of its backends is 64.
1239 # - The maximum number of backend services with fastIPMove in a VPC in a
1240 # region is 64.
1241 # - The network endpoints that are attached to a backend of a backend
1242 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
1243 # - Traffic directed to the leader by a static route next hop will not be
1244 # redirected to a new leader by fast failover. Such traffic will only be
1245 # redirected once an haPolicy.leader update has taken effect. Only traffic
1246 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
1247 # fast failover.
1248 #
1249 #
1250 # haPolicy.fastIPMove can be set only at backend service creation time.
1251 # Once set, it cannot be updated.
1252 #
1253 # By default, fastIpMove is set to DISABLED.
1254 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
1255 # this service as the active endpoint (the leader) that receives all
1256 # traffic.
1257 #
1258 # When the leader changes, there is no connection draining to persist
1259 # existing connections on the old leader.
1260 #
1261 # You are responsible for selecting a suitable endpoint as the
1262 # leader. For example, preferring a healthy endpoint over unhealthy ones.
1263 # Note that this service does not track backend endpoint health, and
1264 # selects the configured leader unconditionally.
1265 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
1266 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
1267 # that the leader is attached to.
1268 #
1269 # The leader&#x27;s backendGroup must already be specified as a backend of
1270 # this backend service. Removing a backend that is designated as the
1271 # leader&#x27;s backendGroup is not permitted.
1272 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
1273 # designated as the leader.
1274 #
1275 # This network endpoint cannot be detached from the NEG specified in
1276 # the haPolicy.leader.backendGroup until the leader is updated with
1277 # another network endpoint, or the leader is removed from the haPolicy.
1278 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
1279 # instance must already be attached to the NEG specified in the
1280 # haPolicy.leader.backendGroup.
1281 #
1282 # The name must be 1-63 characters long, and comply with RFC1035.
1283 # Authorization requires the following IAM permission on the
1284 # specified resource instance: compute.instances.use
1285 },
1286 },
1287 },
1288 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
1289 # httpsHealthChecks (legacy) resource for health checking this backend
1290 # service. Not all backend services support legacy health checks. See
1291 # Load balancer guide. Currently, at most one health check can be
1292 # specified for each backend service. Backend services with
1293 # instance group or zonal NEG backends must have a health check unless
1294 # haPolicy is specified. Backend services with internet or serverless NEG
1295 # backends must not have a health check.
1296 #
1297 # healthChecks[] cannot be specified with haPolicy.
1298 &quot;A String&quot;,
1299 ],
1300 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
1301 # Not available for internal passthrough Network Load Balancers and external
1302 # passthrough Network Load Balancers.
1303 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
1304 # incoming requests.
1305 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
1306 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
1307 # For security reasons, this value cannot be retrieved via the API.
1308 # Instead, the SHA-256 hash of the value is returned in the
1309 # oauth2ClientSecretSha256 field.
1310 #
1311 # @InputOnly
1312 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
1313 },
1314 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1315 # defined by the server.
1316 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
1317 # from the client to the backend for proxyless gRPC).
1318 # The possible values are:
1319 #
1320 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
1321 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1322 # Group), regardless of traffic from the client to the proxy. Only IPv4
1323 # health checks are used to check the health of the backends. This is the
1324 # default setting.
1325 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
1326 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
1327 # address).
1328 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
1329 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1330 # Group), regardless of traffic from the client to the proxy. Only IPv6
1331 # health checks are used to check the health of the backends.
1332 #
1333 #
1334 #
1335 # This field is applicable to either:
1336 #
1337 # - Advanced global external Application Load Balancer (load balancing
1338 # scheme EXTERNAL_MANAGED),
1339 # - Regional external Application Load
1340 # Balancer,
1341 # - Internal proxy Network Load Balancer (load balancing
1342 # scheme INTERNAL_MANAGED),
1343 # - Regional internal Application Load
1344 # Balancer (load balancing scheme INTERNAL_MANAGED),
1345 # - Traffic
1346 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
1347 # INTERNAL_SELF_MANAGED).
1348 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
1349 # for backend services.
1350 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
1351 # created for one type of load balancer cannot be used with another.
1352 # For more information, refer toChoosing
1353 # a load balancer.
1354 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
1355 # preference. When you use localityLbPolicies, you must set at least one
1356 # value for either the localityLbPolicies[].policy or the
1357 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
1358 # value set in the localityLbPolicy field.
1359 #
1360 # For an example of how to use this field, seeDefine
1361 # a list of preferred policies.
1362 #
1363 # Caution: This field and its children are intended for use in a service mesh
1364 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
1365 # that have this configuration.
1366 { # Container for either a built-in LB policy supported by gRPC or Envoy or
1367 # a custom one implemented by the end user.
1368 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
1369 # deployed with the client.
1370 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
1371 # by a locally installed custom policy implementation.
1372 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
1373 #
1374 # The value should match the name of a custom implementation registered
1375 # on the gRPC clients. It should follow protocol buffer message naming
1376 # conventions and include the full path (for example,
1377 # myorg.CustomLbPolicy). The maximum length is 256 characters.
1378 #
1379 # Do not specify the same custom policy more than once for a
1380 # backend. If you do, the configuration is rejected.
1381 #
1382 # For an example of how to use this field, seeUse
1383 # a custom policy.
1384 },
1385 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
1386 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
1387 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
1388 # about these values, see the description of localityLbPolicy.
1389 #
1390 # Do not specify the same policy more than once for a
1391 # backend. If you do, the configuration is rejected.
1392 },
1393 },
1394 ],
1395 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
1396 # possible values are:
1397 #
1398 # - ROUND_ROBIN: This is a simple policy in which each healthy
1399 # backend is selected in round robin order. This is the default.
1400 # - LEAST_REQUEST: An O(1) algorithm which
1401 # selects two random healthy hosts and picks the host which has fewer active
1402 # requests.
1403 # - RING_HASH: The ring/modulo hash load balancer implements
1404 # consistent hashing to backends. The algorithm has the property that the
1405 # addition/removal of a host from a set of N hosts only affects 1/N of the
1406 # requests.
1407 # - RANDOM: The load balancer selects a random healthy
1408 # host.
1409 # - ORIGINAL_DESTINATION: Backend host is selected
1410 # based on the client connection metadata, i.e., connections are opened to
1411 # the same address as the destination address of the incoming connection
1412 # before the connection was redirected to the load balancer.
1413 # - MAGLEV: used as a drop in replacement for the ring hash
1414 # load balancer. Maglev is not as stable as ring hash but has faster table
1415 # lookup build times and host selection times. For more information about
1416 # Maglev, see Maglev:
1417 # A Fast and Reliable Software Network Load Balancer.
1418 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
1419 # Load Balancing using weights computed from Backend reported Custom Metrics.
1420 # If set, the Backend Service responses are expected to contain non-standard
1421 # HTTP response header field Endpoint-Load-Metrics. The reported
1422 # metrics to use for computing the weights are specified via thecustomMetrics field.
1423 #
1424 # This field is applicable to either:
1425 # - A regional backend service with the service protocol set to HTTP,
1426 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
1427 # INTERNAL_MANAGED.
1428 # - A global backend service with the
1429 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
1430 # EXTERNAL_MANAGED.
1431 #
1432 #
1433 # If sessionAffinity is not configured—that is, if session
1434 # affinity remains at the default value of NONE—then the
1435 # default value for localityLbPolicy
1436 # is ROUND_ROBIN. If session affinity is set to a value other
1437 # than NONE,
1438 # then the default value for localityLbPolicy isMAGLEV.
1439 #
1440 # Only ROUND_ROBIN and RING_HASH are supported
1441 # when the backend service is referenced by a URL map that is bound to
1442 # target gRPC proxy that has validateForProxyless field set to true.
1443 #
1444 # localityLbPolicy cannot be specified with haPolicy.
1445 &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
1446 # by this backend service. If logging is enabled, logs will be exported to
1447 # Stackdriver.
1448 # backend service.
1449 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
1450 # traffic served by this backend service. The default value is false.
1451 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
1452 { # Determines which HTTP headers will be logged to Stackdriver.
1453 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1454 },
1455 ],
1456 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
1457 { # Determines which HTTP headers will be logged to Stackdriver.
1458 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1459 },
1460 ],
1461 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
1462 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
1463 # of optional fields you want to include in the logs. For example:
1464 # serverInstance, serverGkeDetails.cluster,
1465 # serverGkeDetails.pod.podNamespace
1466 &quot;A String&quot;,
1467 ],
1468 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
1469 # service. Configures whether all, none or a subset of optional fields
1470 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1471 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1472 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
1473 # service. The value of the field must be in [0, 1]. This configures the
1474 # sampling rate of requests to the load balancer where 1.0 means all logged
1475 # requests are reported and 0.0 means no logged requests are reported. The
1476 # default value is 1.0.
1477 },
1478 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
1479 # service. Duration is computed from the beginning of the stream until the
1480 # response has been completely processed, including all retries. A stream
1481 # that does not complete in this duration is closed.
1482 #
1483 # If not specified, there will be no timeout limit, i.e. the maximum
1484 # duration is infinite.
1485 #
1486 # This value can be overridden in the PathMatcher configuration of the
1487 # UrlMap that references this backend service.
1488 #
1489 # This field is only allowed when the loadBalancingScheme of
1490 # the backend service is INTERNAL_SELF_MANAGED.
1491 # as a count of seconds and fractions of seconds at nanosecond
1492 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1493 # or &quot;month&quot;. Range is approximately 10,000 years.
1494 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1495 # Durations less than one second are represented with a 0
1496 # `seconds` field and a positive `nanos` field. Must be from 0
1497 # to 999,999,999 inclusive.
1498 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1499 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1500 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1501 },
1502 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
1503 # controller and read by the backend RCTH
1504 &quot;a_key&quot;: &quot;A String&quot;,
1505 },
1506 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1507 # The name must be 1-63 characters long, and comply withRFC1035.
1508 # Specifically, the name must be 1-63 characters long and match the regular
1509 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1510 # character must be a lowercase letter, and all following characters must
1511 # be a dash, lowercase letter, or digit, except the last character, which
1512 # cannot be a dash.
1513 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
1514 #
1515 # This field must be set for Internal Passthrough Network Load Balancers when
1516 # the haPolicy is enabled, and for External Passthrough Network Load
1517 # Balancers when the haPolicy fastIpMove is enabled.
1518 #
1519 # 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.
1520 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
1521 # Load Balancers.
1522 #
1523 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
1524 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
1525 # endpoints in the local zone.
1526 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
1527 # possible values are:
1528 #
1529 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
1530 # is disabled. The load balancer distributes new connections to all
1531 # healthy backend endpoints across all zones.
1532 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
1533 # enabled. The load balancer distributes new connections to all healthy
1534 # backend endpoints in the local zone only. If there are no healthy
1535 # backend endpoints in the local zone, the load balancer distributes
1536 # new connections to all backend endpoints in the local zone.
1537 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
1538 # enabled. The load balancer distributes new connections to all healthy
1539 # backend endpoints in the local zone only. If there aren&#x27;t enough
1540 # healthy backend endpoints in the local zone, the load balancer
1541 # distributes new connections to all healthy backend endpoints across all
1542 # zones.
1543 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
1544 # of healthy backend endpoints in a zone to the count of backend
1545 # endpoints in that same zone is equal to or above this threshold, the
1546 # load balancer distributes new connections to all healthy endpoints in
1547 # the local zone only. When the ratio of the count of healthy backend
1548 # endpoints in a zone to the count of backend endpoints in that same
1549 # zone is below this threshold, the load balancer distributes all new
1550 # connections to all healthy endpoints across all zones.
1551 },
1552 },
1553 &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.
1554 # the backend service.
1555 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
1556 # service.
1557 },
1558 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
1559 # load balancing pool of each individual proxy instance that processes the
1560 # traffic for the given backend service. If not set, this feature is
1561 # considered disabled.
1562 #
1563 # Results of the outlier detection algorithm (ejection of endpoints from the
1564 # load balancing pool and returning them back to the pool) are executed
1565 # independently by each proxy instance of the load balancer. In most cases,
1566 # more than one proxy instance handles the traffic received by a backend
1567 # service. Thus, it is possible that an unhealthy endpoint is detected and
1568 # ejected by only some of the proxies, and while this happens, other proxies
1569 # may continue to send requests to the same unhealthy endpoint until they
1570 # detect and eject the unhealthy endpoint.
1571 #
1572 # Applicable backend endpoints can be:
1573 #
1574 # - VM instances in an Instance Group
1575 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
1576 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
1577 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
1578 # Functions Services
1579 # - Private Service Connect NEGs, that resolve to
1580 # Google-managed regional API endpoints or managed services published using
1581 # Private Service Connect
1582 #
1583 #
1584 #
1585 # Applicable backend service types can be:
1586 #
1587 # - A global backend service with the loadBalancingScheme set to
1588 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
1589 # - A regional backend
1590 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
1591 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
1592 # supported for Serverless NEGs.
1593 #
1594 #
1595 #
1596 # Not supported when the backend service is referenced by a URL map that is
1597 # bound to target gRPC proxy that has validateForProxyless field set to true.
1598 # pool for the backend service.
1599 &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
1600 # or 30s.
1601 #
1602 # After a backend endpoint is returned back to the load balancing pool, it
1603 # can be ejected again in another ejection analysis. Thus, the total ejection
1604 # time is equal to the base ejection time multiplied by the number of times
1605 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
1606 # as a count of seconds and fractions of seconds at nanosecond
1607 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1608 # or &quot;month&quot;. Range is approximately 10,000 years.
1609 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1610 # Durations less than one second are represented with a 0
1611 # `seconds` field and a positive `nanos` field. Must be from 0
1612 # to 999,999,999 inclusive.
1613 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1614 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1615 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1616 },
1617 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
1618 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
1619 # return code qualifies as an error. Defaults to 5.
1620 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
1621 # connection errors that are mapped to one of those status codes) before a
1622 # consecutive gateway failure ejection occurs. Defaults to 3.
1623 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1624 # outlier status is detected through consecutive 5xx. This setting can be
1625 # used to disable ejection or to ramp it up slowly. Defaults to 0.
1626 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1627 # outlier status is detected through consecutive gateway failures. This
1628 # setting can be used to disable ejection or to ramp it up slowly. Defaults
1629 # to 100.
1630 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1631 # outlier status is detected through success rate statistics. This setting
1632 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
1633 #
1634 # Not supported when the backend service uses Serverless NEG.
1635 &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
1636 # ejections and backend endpoints being returned to service. The interval is
1637 # equal to the number of seconds as defined in
1638 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
1639 # in outlierDetection.interval.nanos. Defaults to 1 second.
1640 # as a count of seconds and fractions of seconds at nanosecond
1641 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1642 # or &quot;month&quot;. Range is approximately 10,000 years.
1643 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1644 # Durations less than one second are represented with a 0
1645 # `seconds` field and a positive `nanos` field. Must be from 0
1646 # to 999,999,999 inclusive.
1647 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1648 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1649 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1650 },
1651 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
1652 # backend service that can be ejected if the ejection conditions are met.
1653 # Defaults to 50%.
1654 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
1655 # enough request volume to detect success rate outliers. If the number of
1656 # backend endpoints is fewer than this setting, outlier detection via success
1657 # rate statistics is not performed for any backend endpoint in the load
1658 # balancing pool. Defaults to 5.
1659 #
1660 # Not supported when the backend service uses Serverless NEG.
1661 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
1662 # (as defined by the interval duration above) to include this backend
1663 # endpoint in success rate based outlier detection. If the volume is lower
1664 # than this setting, outlier detection via success rate statistics is not
1665 # performed for that backend endpoint. Defaults to 100.
1666 #
1667 # Not supported when the backend service uses Serverless NEG.
1668 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
1669 # outlier ejection. The ejection threshold is the difference between the mean
1670 # success rate, and the product of this factor and the standard deviation of
1671 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
1672 # is divided by a thousand to get a double. That is, if the desired factor
1673 # is 1.9, the runtime value should be 1900. Defaults to 1900.
1674 #
1675 # Not supported when the backend service uses Serverless NEG.
1676 },
1677 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1678 # as part of resource payload.
1679 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1680 # Tag keys and values have the same definition as resource
1681 # manager tags. The field is allowed for INSERT
1682 # only. The keys/values to set on the resource should be specified in
1683 # either ID { : } or Namespaced format
1684 # { : }.
1685 # For example the following are valid inputs:
1686 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1687 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1688 # Note:
1689 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1690 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1691 &quot;a_key&quot;: &quot;A String&quot;,
1692 },
1693 },
1694 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
1695 # the backend. The default value is 80.
1696 # For internal passthrough Network Load Balancers and external passthrough
1697 # Network Load Balancers, omit port.
1698 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
1699 # communication to the backend VMs in that group. The
1700 # named port must be [defined on each backend instance
1701 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
1702 # This parameter has no meaning if the backends are NEGs. For internal
1703 # passthrough Network Load Balancers and external passthrough Network Load
1704 # Balancers, omit port_name.
1705 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
1706 # with backends.
1707 #
1708 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
1709 # depending on the chosen load balancer or Traffic Director configuration.
1710 # Refer to the documentation for the load balancers or for Traffic Director
1711 # for more information.
1712 #
1713 # Must be set to GRPC when the backend service is referenced by a URL map
1714 # that is bound to target gRPC proxy.
1715 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
1716 # resides. This field is not applicable to global backend services.
1717 # You must specify this field as part of the HTTP request URL. It is
1718 # not settable as a field in the request body.
1719 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1720 # backend service.
1721 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
1722 # service. This field is applicable to a global backend service with the
1723 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
1724 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
1725 &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
1726 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
1727 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
1728 # private storage buckets that support Signature Version 4 for authentication.
1729 # The service name for generating the authentication header will always default
1730 # to &#x27;s3&#x27;.
1731 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
1732 # creating a backend that uses AWS v4 signature authentication, but will not
1733 # be returned as part of the configuration when queried with a REST API GET
1734 # request.
1735 #
1736 # @InputOnly
1737 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
1738 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
1739 # keep track of different iterations of your access key.
1740 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
1741 # the name of the region your cloud uses to host your origin. For example,
1742 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
1743 },
1744 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
1745 # that describes how clients should authenticate with this service&#x27;s
1746 # backends.
1747 #
1748 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
1749 # to INTERNAL_SELF_MANAGED.
1750 #
1751 # If left blank, communications are not encrypted.
1752 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
1753 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
1754 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
1755 # specified values, the communication continues. Otherwise, it fails. This
1756 # additional check enables the client to verify that the server is authorized
1757 # to run the requested service.
1758 #
1759 # Note that the contents of the server
1760 # certificate&#x27;s subjectAltName field are configured by the
1761 # Public Key Infrastructure which provisions server identities.
1762 #
1763 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
1764 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
1765 # mode).
1766 &quot;A String&quot;,
1767 ],
1768 },
1769 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1770 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
1771 #
1772 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
1773 # If set, lists of backends and health checks must be both empty.
1774 &quot;A String&quot;,
1775 ],
1776 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
1777 #
1778 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
1779 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
1780 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
1781 #
1782 # Only NONE and HEADER_FIELD are supported
1783 # when the backend service is referenced by a URL map that is bound to
1784 # target gRPC proxy that has validateForProxyless field set to true.
1785 #
1786 # For more details, see:
1787 # [Session
1788 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
1789 #
1790 # sessionAffinity cannot be specified with haPolicy.
1791 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
1792 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
1793 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
1794 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
1795 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
1796 # as a count of seconds and fractions of seconds at nanosecond
1797 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1798 # or &quot;month&quot;. Range is approximately 10,000 years.
1799 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1800 # Durations less than one second are represented with a 0
1801 # `seconds` field and a positive `nanos` field. Must be from 0
1802 # to 999,999,999 inclusive.
1803 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1804 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1805 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1806 },
1807 },
1808 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
1809 # Currently this is applicable only for Internal TCP/UDP load balancing,
1810 # Internal HTTP(S) load balancing and Traffic Director.
1811 &quot;policy&quot;: &quot;A String&quot;,
1812 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
1813 # each service mesh client.
1814 #
1815 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
1816 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
1817 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
1818 # `INTERNAL_SELF_MANAGED`.
1819 #
1820 # `subset_size` is optional for Internal HTTP(S) load balancing
1821 # and required for Traffic Director.
1822 #
1823 # If you do not provide this value, Cloud Load Balancing will calculate it
1824 # dynamically to optimize the number of proxies/clients visible to each
1825 # backend and vice versa.
1826 #
1827 # Must be greater than 0. If `subset_size` is larger than the number of
1828 # backends/endpoints, then subsetting is disabled.
1829 },
1830 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
1831 # type of load balancer. For more information see,
1832 # Backend service settings.
1833 # The default is 30 seconds.
1834 # The full range of timeout values allowed goes from 1
1835 # through 2,147,483,647 seconds.
1836 #
1837 # This value can be overridden in the PathMatcher configuration of the
1838 # UrlMap that references this backend service.
1839 #
1840 # Not supported when the backend service is referenced by a URL map that is
1841 # bound to target gRPC proxy that has validateForProxyless field set to true.
1842 # Instead, use maxStreamDuration.
1843 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
1844 # when the backend protocol is SSL, HTTPS or HTTP2.
1845 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
1846 # networksecurity.googleapis.com namespace. Can be used in authenticating
1847 # TLS connections to the backend, as specified by the authenticationMode
1848 # field. Can only be specified if authenticationMode is not NONE.
1849 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
1850 #
1851 #
1852 # Use this property to configure the load balancer back-end to use
1853 # certificates and roots of trust provisioned by the Managed Workload
1854 # Identity system.
1855 #
1856 # The `identity` property is the
1857 # fully-specified SPIFFE ID to use in the SVID presented by the Load
1858 # Balancer Workload.
1859 #
1860 # The SPIFFE ID must be a resource starting with the
1861 # `trustDomain` property value, followed by the path to the Managed
1862 # Workload Identity.
1863 #
1864 # Supported SPIFFE ID format:
1865 #
1866 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
1867 #
1868 #
1869 # The Trust Domain within the Managed Identity must refer to a valid
1870 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
1871 # will be inherited from the Workload Identity Pool.
1872 #
1873 # Restrictions:
1874 #
1875 # - If you set the `identity` property, you cannot manually set
1876 # the following fields:
1877 # - tlsSettings.sni
1878 # - tlsSettings.subjectAltNames
1879 # - tlsSettings.authenticationConfig
1880 #
1881 #
1882 # When defining a `identity` for a RegionBackendServices, the
1883 # corresponding Workload Identity Pool must have a ca_pool
1884 # configured in the same region.
1885 #
1886 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
1887 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
1888 # balancer sends this string as the SNI hostname in the TLS connection to
1889 # the backend, and requires that this string match a Subject Alternative
1890 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
1891 # NEG backend, if the SNI is specified here, the load balancer uses it
1892 # regardless of whether the Regional Internet NEG is specified with FQDN or
1893 # IP address and port. When both sni and subjectAltNames[] are specified,
1894 # the load balancer matches the backend certificate&#x27;s SAN only to
1895 # subjectAltNames[].
1896 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
1897 # verifies during a TLS handshake with the backend. When the server
1898 # presents its X.509 certificate to the Load Balancer, the Load Balancer
1899 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
1900 # match one of the subjectAltNames in the list. This field is limited to 5
1901 # entries. When both sni and subjectAltNames[] are specified, the load
1902 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
1903 { # A Subject Alternative Name that the load balancer matches against the SAN
1904 # field in the TLS certificate provided by the backend, specified as either
1905 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
1906 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
1907 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
1908 },
1909 ],
1910 },
1911 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
1912 {
1913 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
1914 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
1915 # and ForwardingRule.
1916 },
1917 ],
1918 },
1919 ],
1920 &quot;warning&quot;: { # Informational warning which replaces the list of
1921 # backend services when the list is empty.
1922 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1923 # Engine returns NO_RESULTS_ON_PAGE if there
1924 # are no results in the response.
1925 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1926 # value format. For example:
1927 #
1928 # &quot;data&quot;: [
1929 # {
1930 # &quot;key&quot;: &quot;scope&quot;,
1931 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1932 # }
1933 {
1934 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1935 # returned. For example, for warnings where there are no results in a list
1936 # request for a particular zone, this key might be scope and
1937 # the key value might be the zone name. Other examples might be a key
1938 # indicating a deprecated resource and a suggested replacement, or a
1939 # warning about invalid network settings (for example, if an instance
1940 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1941 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1942 },
1943 ],
1944 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1945 },
1946 },
1947 },
1948 &quot;kind&quot;: &quot;compute#backendServiceAggregatedList&quot;, # Output only. Type of resource.
1949 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1950 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1951 # the query parameter pageToken in the next list request.
1952 # Subsequent list requests will have their own nextPageToken to
1953 # continue paging through the results.
1954 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1955 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1956 &quot;A String&quot;,
1957 ],
1958 &quot;warning&quot;: { # [Output Only] Informational warning message.
1959 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1960 # Engine returns NO_RESULTS_ON_PAGE if there
1961 # are no results in the response.
1962 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1963 # value format. For example:
1964 #
1965 # &quot;data&quot;: [
1966 # {
1967 # &quot;key&quot;: &quot;scope&quot;,
1968 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1969 # }
1970 {
1971 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1972 # returned. For example, for warnings where there are no results in a list
1973 # request for a particular zone, this key might be scope and
1974 # the key value might be the zone name. Other examples might be a key
1975 # indicating a deprecated resource and a suggested replacement, or a
1976 # warning about invalid network settings (for example, if an instance
1977 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1978 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1979 },
1980 ],
1981 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1982 },
1983 }</pre>
1984 </div>
1985
1986 <div class="method">
1987 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1988 <pre>Retrieves the next page of results.
1989
1990 Args:
1991 previous_request: The request for the previous page. (required)
1992 previous_response: The response from the request for the previous page. (required)
1993
1994 Returns:
1995 A request object that you can call &#x27;execute()&#x27; on to request the next
1996 page. Returns None if there are no more items in the collection.
1997 </pre>
1998 </div>
1999
2000 <div class="method">
2001 <code class="details" id="close">close()</code>
2002 <pre>Close httplib2 connections.</pre>
2003 </div>
2004
2005 <div class="method">
2006 <code class="details" id="delete">delete(project, backendService, requestId=None, x__xgafv=None)</code>
2007 <pre>Deletes the specified BackendService resource.
2008
2009 Args:
2010 project: string, Project ID for this request. (required)
2011 backendService: string, Name of the BackendService resource to delete. (required)
2012 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2013 that if you must retry your request, the server will know to ignore the
2014 request if it has already been completed.
2015
2016 For example, consider a situation where you make an initial request and
2017 the request times out. If you make the request again with the same
2018 request ID, the server can check if original operation with the same
2019 request ID was received, and if so, will ignore the second request. This
2020 prevents clients from accidentally creating duplicate commitments.
2021
2022 The request ID must be
2023 a valid UUID with the exception that zero UUID is not supported
2024 (00000000-0000-0000-0000-000000000000).
2025 x__xgafv: string, V1 error format.
2026 Allowed values
2027 1 - v1 error format
2028 2 - v2 error format
2029
2030 Returns:
2031 An object of the form:
2032
2033 { # Represents an Operation resource.
2034 #
2035 # Google Compute Engine has three Operation resources:
2036 #
2037 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2038 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2039 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2040 #
2041 # You can use an operation resource to manage asynchronous API requests.
2042 # For more information, readHandling
2043 # API responses.
2044 #
2045 # Operations can be global, regional or zonal.
2046 #
2047 # - For global operations, use the `globalOperations`
2048 # resource.
2049 # - For regional operations, use the
2050 # `regionOperations` resource.
2051 # - For zonal operations, use
2052 # the `zoneOperations` resource.
2053 #
2054 #
2055 #
2056 # For more information, read
2057 # Global, Regional, and Zonal Resources.
2058 #
2059 # Note that completed Operation resources have a limited
2060 # retention period.
2061 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2062 # Not present otherwise.
2063 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2064 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2065 # set when the operation is created.
2066 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2067 # text format.
2068 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2069 # this field will be populated.
2070 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2071 # operation.
2072 {
2073 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2074 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2075 # details. There is a set of defined message types to use for providing
2076 # details.The syntax depends on the error code. For example,
2077 # QuotaExceededInfo will have details when the error code is
2078 # QUOTA_EXCEEDED.
2079 {
2080 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2081 #
2082 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2083 # is not enabled:
2084 #
2085 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2086 # &quot;domain&quot;: &quot;googleapis.com&quot;
2087 # &quot;metadata&quot;: {
2088 # &quot;resource&quot;: &quot;projects/123&quot;,
2089 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2090 # }
2091 # }
2092 #
2093 # This response indicates that the pubsub.googleapis.com API is not enabled.
2094 #
2095 # Example of an error that is returned when attempting to create a Spanner
2096 # instance in a region that is out of stock:
2097 #
2098 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2099 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2100 # &quot;metadata&quot;: {
2101 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2102 # }
2103 # }
2104 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2105 # is typically the registered service name of the tool or product that
2106 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2107 # generated by some common infrastructure, the error domain must be a
2108 # globally unique value that identifies the infrastructure. For Google API
2109 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2110 &quot;metadatas&quot;: { # Additional structured details about this error.
2111 #
2112 # Keys must match a regular expression of `a-z+` but should
2113 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2114 # length. When identifying the current value of an exceeded limit, the units
2115 # should be contained in the key, not the value. For example, rather than
2116 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2117 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2118 # instances that can be created in a single (batch) request.
2119 &quot;a_key&quot;: &quot;A String&quot;,
2120 },
2121 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2122 # proximate cause of the error. Error reasons are unique within a particular
2123 # domain of errors. This should be at most 63 characters and match a
2124 # regular expression of `A-Z+[A-Z0-9]`, which represents
2125 # UPPER_SNAKE_CASE.
2126 },
2127 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2128 #
2129 # For example, if a quota check failed with an error indicating the calling
2130 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2131 # directly to the right place in the developer console to flip the bit.
2132 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2133 { # Describes a URL link.
2134 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2135 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2136 },
2137 ],
2138 },
2139 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2140 # which can be attached to an RPC error.
2141 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2142 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2143 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2144 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2145 },
2146 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2147 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2148 &quot;a_key&quot;: &quot;A String&quot;,
2149 },
2150 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2151 # type or metric.
2152 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2153 # or metric.
2154 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2155 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2156 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2157 },
2158 },
2159 ],
2160 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2161 # This property is optional.
2162 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2163 },
2164 ],
2165 },
2166 &quot;getVersionOperationMetadata&quot;: {
2167 &quot;inlineSbomInfo&quot;: {
2168 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2169 # appropriate identifiers.
2170 &quot;a_key&quot;: &quot;A String&quot;,
2171 },
2172 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2173 # identifiers.
2174 &quot;a_key&quot;: &quot;A String&quot;,
2175 },
2176 },
2177 },
2178 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2179 # message that was returned, such as `NOT FOUND`.
2180 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2181 # status code that was returned. For example, a `404` means the
2182 # resource was not found.
2183 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2184 # defined by the server.
2185 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2186 # This value is inRFC3339
2187 # text format.
2188 &quot;instancesBulkInsertOperationMetadata&quot;: {
2189 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2190 # Example key: zones/us-central1-a
2191 &quot;a_key&quot;: {
2192 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2193 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2194 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2195 # error.
2196 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2197 # if the flow is rolling forward or rolling back.
2198 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2199 },
2200 },
2201 },
2202 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2203 # Operation resources.
2204 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2205 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2206 # group of operations results from a `bulkInsert` API request.
2207 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2208 # `update`, or `delete`, and so on.
2209 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2210 # There is no requirement that this be linear or support any granularity of
2211 # operations. This should not be used to guess when the operation will be
2212 # complete. This number should monotonically increase as the operation
2213 # progresses.
2214 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2215 # applicable when performing regional operations.
2216 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2217 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2218 # this field will contain information on all underlying zonal actions and
2219 # their state.
2220 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2221 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2222 # Example key: zones/us-central1-a
2223 &quot;a_key&quot;: {
2224 &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
2225 # populated.
2226 # different programming environments, including REST APIs and RPC APIs. It is
2227 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2228 # three pieces of data: error code, error message, and error details.
2229 #
2230 # You can find out more about this error model and how to work with it in the
2231 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2232 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2233 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2234 # message types for APIs to use.
2235 {
2236 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2237 },
2238 ],
2239 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2240 # user-facing error message should be localized and sent in the
2241 # google.rpc.Status.details field, or localized by the client.
2242 },
2243 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2244 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2245 },
2246 },
2247 },
2248 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2249 # This value is inRFC3339
2250 # text format.
2251 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2252 # following:
2253 # `PENDING`, `RUNNING`, or `DONE`.
2254 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2255 # operation.
2256 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2257 # of the target resource.
2258 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2259 # operations related to creating a snapshot, this points to the disk
2260 # that the snapshot was created from.
2261 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2262 # `[email protected]` or
2263 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2264 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2265 # operation, this field will be populated.
2266 {
2267 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2268 # Engine returns NO_RESULTS_ON_PAGE if there
2269 # are no results in the response.
2270 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2271 # value format. For example:
2272 #
2273 # &quot;data&quot;: [
2274 # {
2275 # &quot;key&quot;: &quot;scope&quot;,
2276 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2277 # }
2278 {
2279 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2280 # returned. For example, for warnings where there are no results in a list
2281 # request for a particular zone, this key might be scope and
2282 # the key value might be the zone name. Other examples might be a key
2283 # indicating a deprecated resource and a suggested replacement, or a
2284 # warning about invalid network settings (for example, if an instance
2285 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2286 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2287 },
2288 ],
2289 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2290 },
2291 ],
2292 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2293 # applicable when performing per-zone operations.
2294 }</pre>
2295 </div>
2296
2297 <div class="method">
2298 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None, x__xgafv=None)</code>
2299 <pre>Deletes a key for validating requests with signed URLs for this backend
2300 service.
2301
2302 Args:
2303 project: string, Project ID for this request. (required)
2304 backendService: string, Name of the BackendService resource to which the Signed URL Key should be
2305 added. The name should conform to RFC1035. (required)
2306 keyName: string, The name of the Signed URL Key to delete. (required)
2307 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2308 that if you must retry your request, the server will know to ignore the
2309 request if it has already been completed.
2310
2311 For example, consider a situation where you make an initial request and
2312 the request times out. If you make the request again with the same
2313 request ID, the server can check if original operation with the same
2314 request ID was received, and if so, will ignore the second request. This
2315 prevents clients from accidentally creating duplicate commitments.
2316
2317 The request ID must be
2318 a valid UUID with the exception that zero UUID is not supported
2319 (00000000-0000-0000-0000-000000000000).
2320 x__xgafv: string, V1 error format.
2321 Allowed values
2322 1 - v1 error format
2323 2 - v2 error format
2324
2325 Returns:
2326 An object of the form:
2327
2328 { # Represents an Operation resource.
2329 #
2330 # Google Compute Engine has three Operation resources:
2331 #
2332 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2333 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2334 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2335 #
2336 # You can use an operation resource to manage asynchronous API requests.
2337 # For more information, readHandling
2338 # API responses.
2339 #
2340 # Operations can be global, regional or zonal.
2341 #
2342 # - For global operations, use the `globalOperations`
2343 # resource.
2344 # - For regional operations, use the
2345 # `regionOperations` resource.
2346 # - For zonal operations, use
2347 # the `zoneOperations` resource.
2348 #
2349 #
2350 #
2351 # For more information, read
2352 # Global, Regional, and Zonal Resources.
2353 #
2354 # Note that completed Operation resources have a limited
2355 # retention period.
2356 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2357 # Not present otherwise.
2358 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2359 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2360 # set when the operation is created.
2361 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2362 # text format.
2363 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2364 # this field will be populated.
2365 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2366 # operation.
2367 {
2368 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2369 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2370 # details. There is a set of defined message types to use for providing
2371 # details.The syntax depends on the error code. For example,
2372 # QuotaExceededInfo will have details when the error code is
2373 # QUOTA_EXCEEDED.
2374 {
2375 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2376 #
2377 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2378 # is not enabled:
2379 #
2380 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2381 # &quot;domain&quot;: &quot;googleapis.com&quot;
2382 # &quot;metadata&quot;: {
2383 # &quot;resource&quot;: &quot;projects/123&quot;,
2384 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2385 # }
2386 # }
2387 #
2388 # This response indicates that the pubsub.googleapis.com API is not enabled.
2389 #
2390 # Example of an error that is returned when attempting to create a Spanner
2391 # instance in a region that is out of stock:
2392 #
2393 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2394 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2395 # &quot;metadata&quot;: {
2396 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2397 # }
2398 # }
2399 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2400 # is typically the registered service name of the tool or product that
2401 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2402 # generated by some common infrastructure, the error domain must be a
2403 # globally unique value that identifies the infrastructure. For Google API
2404 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2405 &quot;metadatas&quot;: { # Additional structured details about this error.
2406 #
2407 # Keys must match a regular expression of `a-z+` but should
2408 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2409 # length. When identifying the current value of an exceeded limit, the units
2410 # should be contained in the key, not the value. For example, rather than
2411 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2412 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2413 # instances that can be created in a single (batch) request.
2414 &quot;a_key&quot;: &quot;A String&quot;,
2415 },
2416 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2417 # proximate cause of the error. Error reasons are unique within a particular
2418 # domain of errors. This should be at most 63 characters and match a
2419 # regular expression of `A-Z+[A-Z0-9]`, which represents
2420 # UPPER_SNAKE_CASE.
2421 },
2422 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2423 #
2424 # For example, if a quota check failed with an error indicating the calling
2425 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2426 # directly to the right place in the developer console to flip the bit.
2427 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2428 { # Describes a URL link.
2429 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2430 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2431 },
2432 ],
2433 },
2434 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2435 # which can be attached to an RPC error.
2436 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2437 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2438 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2439 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2440 },
2441 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2442 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2443 &quot;a_key&quot;: &quot;A String&quot;,
2444 },
2445 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2446 # type or metric.
2447 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2448 # or metric.
2449 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2450 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2451 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2452 },
2453 },
2454 ],
2455 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2456 # This property is optional.
2457 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2458 },
2459 ],
2460 },
2461 &quot;getVersionOperationMetadata&quot;: {
2462 &quot;inlineSbomInfo&quot;: {
2463 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2464 # appropriate identifiers.
2465 &quot;a_key&quot;: &quot;A String&quot;,
2466 },
2467 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2468 # identifiers.
2469 &quot;a_key&quot;: &quot;A String&quot;,
2470 },
2471 },
2472 },
2473 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2474 # message that was returned, such as `NOT FOUND`.
2475 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2476 # status code that was returned. For example, a `404` means the
2477 # resource was not found.
2478 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2479 # defined by the server.
2480 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2481 # This value is inRFC3339
2482 # text format.
2483 &quot;instancesBulkInsertOperationMetadata&quot;: {
2484 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2485 # Example key: zones/us-central1-a
2486 &quot;a_key&quot;: {
2487 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2488 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2489 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2490 # error.
2491 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2492 # if the flow is rolling forward or rolling back.
2493 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2494 },
2495 },
2496 },
2497 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2498 # Operation resources.
2499 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2500 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2501 # group of operations results from a `bulkInsert` API request.
2502 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2503 # `update`, or `delete`, and so on.
2504 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2505 # There is no requirement that this be linear or support any granularity of
2506 # operations. This should not be used to guess when the operation will be
2507 # complete. This number should monotonically increase as the operation
2508 # progresses.
2509 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2510 # applicable when performing regional operations.
2511 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2512 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2513 # this field will contain information on all underlying zonal actions and
2514 # their state.
2515 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2516 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2517 # Example key: zones/us-central1-a
2518 &quot;a_key&quot;: {
2519 &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
2520 # populated.
2521 # different programming environments, including REST APIs and RPC APIs. It is
2522 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2523 # three pieces of data: error code, error message, and error details.
2524 #
2525 # You can find out more about this error model and how to work with it in the
2526 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2527 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2528 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2529 # message types for APIs to use.
2530 {
2531 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2532 },
2533 ],
2534 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2535 # user-facing error message should be localized and sent in the
2536 # google.rpc.Status.details field, or localized by the client.
2537 },
2538 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2539 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2540 },
2541 },
2542 },
2543 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2544 # This value is inRFC3339
2545 # text format.
2546 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2547 # following:
2548 # `PENDING`, `RUNNING`, or `DONE`.
2549 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2550 # operation.
2551 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2552 # of the target resource.
2553 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2554 # operations related to creating a snapshot, this points to the disk
2555 # that the snapshot was created from.
2556 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2557 # `[email protected]` or
2558 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2559 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2560 # operation, this field will be populated.
2561 {
2562 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2563 # Engine returns NO_RESULTS_ON_PAGE if there
2564 # are no results in the response.
2565 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2566 # value format. For example:
2567 #
2568 # &quot;data&quot;: [
2569 # {
2570 # &quot;key&quot;: &quot;scope&quot;,
2571 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2572 # }
2573 {
2574 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2575 # returned. For example, for warnings where there are no results in a list
2576 # request for a particular zone, this key might be scope and
2577 # the key value might be the zone name. Other examples might be a key
2578 # indicating a deprecated resource and a suggested replacement, or a
2579 # warning about invalid network settings (for example, if an instance
2580 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2581 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2582 },
2583 ],
2584 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2585 },
2586 ],
2587 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2588 # applicable when performing per-zone operations.
2589 }</pre>
2590 </div>
2591
2592 <div class="method">
2593 <code class="details" id="get">get(project, backendService, x__xgafv=None)</code>
2594 <pre>Returns the specified BackendService resource.
2595
2596 Args:
2597 project: string, Project ID for this request. (required)
2598 backendService: string, Name of the BackendService resource to return. (required)
2599 x__xgafv: string, V1 error format.
2600 Allowed values
2601 1 - v1 error format
2602 2 - v2 error format
2603
2604 Returns:
2605 An object of the form:
2606
2607 { # Represents a Backend Service resource.
2608 #
2609 # A backend service defines how Google Cloud load balancers distribute traffic.
2610 # The backend service configuration contains a set of values, such as the
2611 # protocol used to connect to backends, various distribution and session
2612 # settings, health checks, and timeouts. These settings provide fine-grained
2613 # control over how your load balancer behaves. Most of the settings have
2614 # default values that allow for easy configuration if you need to get started
2615 # quickly.
2616 #
2617 # Backend services in Google Compute Engine can be either regionally or
2618 # globally scoped.
2619 #
2620 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
2621 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
2622 #
2623 # For more information, seeBackend
2624 # Services.
2625 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
2626 # Load Balancers and Traffic Director and requires
2627 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
2628 #
2629 # If set to 0, the cookie is non-persistent and lasts only until
2630 # the end of the browser session (or equivalent). The maximum allowed value
2631 # is two weeks (1,209,600).
2632 #
2633 # Not supported when the backend service is referenced by a URL map that is
2634 # bound to target gRPC proxy that has validateForProxyless field set to true.
2635 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
2636 { # Message containing information of one individual backend.
2637 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
2638 # handle additional traffic or is fully loaded. For usage guidelines, see
2639 # Connection balancing mode.
2640 #
2641 # Backends must use compatible balancing modes. For more information, see
2642 # Supported balancing modes and target capacity settings and
2643 # Restrictions and guidance for instance groups.
2644 #
2645 # Note: Currently, if you use the API to configure incompatible balancing
2646 # modes, the configuration might be accepted even though it has no impact
2647 # and is ignored. Specifically, Backend.maxUtilization is ignored when
2648 # Backend.balancingMode is RATE. In the future, this incompatible combination
2649 # will be rejected.
2650 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
2651 # mode.
2652 # The default value is 1, which means the group serves up to
2653 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
2654 # completely drained, offering 0% of its available capacity. The valid ranges
2655 # are 0.0 and [0.1,1.0].
2656 # You cannot configure a setting larger than 0 and smaller than0.1.
2657 # You cannot configure a setting of 0 when there is only one
2658 # backend attached to the backend service.
2659 #
2660 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
2661 # internet NEGs, regional serverless NEGs, and PSC NEGs.
2662 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
2663 # BalancingMode.
2664 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
2665 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
2666 # Monitoring, but is not used for load balancing.
2667 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
2668 # balancing mode. The valid range is [0.0, 1.0].
2669 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2670 # long and match the regular expression
2671 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2672 # first character must be a lowercase letter, and all following
2673 # characters must be a dash, period, underscore, lowercase letter, or
2674 # digit, except the last character, which cannot be a dash, period, or
2675 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2676 # field can only be used for a global or regional backend service with the
2677 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2678 },
2679 ],
2680 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2681 # create the resource.
2682 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
2683 # failover backend can be configured for a given BackendService.
2684 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
2685 # group or network endpoint
2686 # group (NEG) resource. To determine what types of backends a load
2687 # balancer supports, see the [Backend services
2688 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
2689 #
2690 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
2691 # or NEG. Partial URLs are not supported.
2692 #
2693 # If haPolicy is specified, backends must refer to NEG resources of type
2694 # GCE_VM_IP.
2695 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2696 # guidelines, seeConnection
2697 # balancing mode and Utilization
2698 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
2699 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2700 # guidelines, seeConnection
2701 # balancing mode and Utilization
2702 # balancing mode.
2703 #
2704 # Not available if the backend&#x27;s balancingMode isRATE.
2705 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
2706 # For usage guidelines, seeConnection
2707 # balancing mode and Utilization
2708 # balancing mode.
2709 #
2710 # Not available if the backend&#x27;s balancingMode isRATE.
2711 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
2712 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
2713 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
2714 # Not available if backend&#x27;s balancingMode is RATE
2715 # or CONNECTION.
2716 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
2717 # Not available if backend&#x27;s balancingMode is RATE
2718 # or CONNECTION.
2719 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
2720 # usage guidelines, seeRate
2721 # balancing mode and Utilization
2722 # balancing mode.
2723 #
2724 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2725 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2726 # guidelines, seeRate
2727 # balancing mode and Utilization
2728 # balancing mode.
2729 #
2730 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2731 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2732 # guidelines, seeRate
2733 # balancing mode and Utilization
2734 # balancing mode.
2735 #
2736 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2737 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
2738 #
2739 # For usage guidelines, seeUtilization
2740 # balancing mode.
2741 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
2742 # the backend.
2743 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
2744 },
2745 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
2746 # sending traffic to backends with default preference. The possible values
2747 # are:
2748 #
2749 # - PREFERRED: Backends with this preference level will be
2750 # filled up to their capacity limits first, based on RTT.
2751 # - DEFAULT: If preferred backends don&#x27;t have enough
2752 # capacity, backends in this layer would be used and traffic would be
2753 # assigned based on the load balancing algorithm you use. This is the
2754 # default
2755 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
2756 # Attachment).
2757 # e.g.
2758 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
2759 # for Cloud Run service.
2760 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
2761 # for PSC Service Attachment.
2762 &quot;trafficDuration&quot;: &quot;A String&quot;,
2763 },
2764 ],
2765 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
2766 # specified load balancer types.
2767 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2768 # Pragma or Authorization headers. Up to 5 headers can be specified.
2769 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2770 { # Bypass the cache when the specified request headers are present,
2771 # e.g. Pragma or Authorization headers. Values are case insensitive.
2772 # The presence of such a header overrides the cache_mode setting.
2773 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2774 # Values are case-insensitive.
2775 },
2776 ],
2777 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
2778 # CDN.
2779 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
2780 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2781 &quot;A String&quot;,
2782 ],
2783 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
2784 # The name=value pair will be used in the cache key Cloud CDN generates.
2785 &quot;A String&quot;,
2786 ],
2787 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
2788 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
2789 # query_string_whitelist and query_string_blacklist. If neither is set, the
2790 # entire query string will be included. If false, the query string will be
2791 # excluded from the cache key entirely.
2792 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
2793 # parameters will be included. Either specify query_string_whitelist or
2794 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2795 # not treated as delimiters.
2796 &quot;A String&quot;,
2797 ],
2798 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
2799 # parameters will be excluded. Either specify query_string_whitelist or
2800 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2801 # not treated as delimiters.
2802 &quot;A String&quot;,
2803 ],
2804 },
2805 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2806 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2807 # headers to cache content. Responses without these headers will not be
2808 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2809 # every request, potentially impacting performance and increasing load on
2810 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2811 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2812 # Warning: this may result in Cloud CDN caching private,
2813 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2814 # including common image formats, media (video and audio), and web assets
2815 # (JavaScript and CSS). Requests and responses that are marked as
2816 # uncacheable, as well as dynamic content (including HTML), will not be
2817 # cached.
2818 #
2819 # If no value is provided for cdnPolicy.cacheMode, it defaults
2820 # to CACHE_ALL_STATIC.
2821 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2822 # used to clamp the max-age (or Expires) value sent to the client. With
2823 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2824 # response max-age directive, along with a &quot;public&quot; directive. For
2825 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2826 # from the origin (if specified), or else sets the response max-age
2827 # directive to the lesser of the client_ttl and default_ttl, and also
2828 # ensures a &quot;public&quot; cache-control directive is present.
2829 # If a client TTL is not specified, a default value (1 hour) will be used.
2830 # The maximum allowed value is 31,622,400s (1 year).
2831 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2832 # responses that do not have an existing valid TTL (max-age or s-maxage).
2833 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2834 # The value of defaultTTL cannot be set to a value greater than that of
2835 # maxTTL, but can be equal.
2836 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2837 # will overwrite the TTL set in all responses. The maximum allowed value is
2838 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2839 # evicted from the cache before the defined TTL.
2840 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2841 # origin.
2842 # Cache directives that attempt to set a max-age or s-maxage higher than
2843 # this, or an Expires header more than maxTTL seconds in the future will
2844 # be capped at the value of maxTTL, as if it were the value of an
2845 # s-maxage Cache-Control directive.
2846 # Headers sent to the client will not be modified.
2847 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2848 # The maximum allowed value is 31,622,400s (1 year), noting that
2849 # infrequently accessed objects may be evicted from the cache before
2850 # the defined TTL.
2851 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2852 # to apply fine-grained caching for common errors or redirects.
2853 # This can reduce the load on your origin and improve end-user
2854 # experience by reducing response latency.
2855 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2856 # negative caching applies to responses with the specified response code
2857 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2858 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2859 # to all responses with the specified response code, and override any
2860 # caching headers.
2861 # By default, Cloud CDN will apply the following default TTLs to these
2862 # status codes:
2863 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2864 # HTTP 404 (Not Found), 410 (Gone),
2865 # 451 (Unavailable For Legal Reasons): 120s
2866 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2867 # These defaults can be overridden in negative_caching_policy.
2868 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2869 # negative_caching must be enabled to configure negative_caching_policy.
2870 # Omitting the policy and leaving negative_caching enabled will use
2871 # Cloud CDN&#x27;s default cache TTLs.
2872 # Note that when specifying an explicit negative_caching_policy, you
2873 # should take care to specify a cache TTL for all response codes
2874 # that you wish to cache. Cloud CDN will not apply any default
2875 # negative caching when a policy exists.
2876 { # Specify CDN TTLs for response error codes.
2877 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2878 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2879 # specified as values, and you cannot specify a status code more than
2880 # once.
2881 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2882 # corresponding status code.
2883 # The maximum allowed value is 1800s (30 minutes), noting that
2884 # infrequently accessed objects may be evicted from the cache before the
2885 # defined TTL.
2886 },
2887 ],
2888 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2889 # requests into a small number of requests to the origin.
2890 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2891 # content with the origin, or when an error is encountered when refreshing
2892 # the cache.
2893 # This setting defines the default &quot;max-stale&quot; duration for any cached
2894 # responses that do not specify a max-stale directive. Stale responses that
2895 # exceed the TTL configured here will not be served. The default limit
2896 # (max-stale) is 86400s (1 day), which will allow stale content to be
2897 # served up to this limit beyond the max-age (or s-maxage) of a cached
2898 # response.
2899 # The maximum allowed value is 604800 (1 week).
2900 # Set this to zero (0) to disable serve-while-stale.
2901 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2902 # considered fresh. After this time period, the response will be
2903 # revalidated before being served. Defaults to 1hr (3600s). When serving
2904 # responses to signed URL requests, Cloud CDN will internally behave as
2905 # though all responses from this backend had a &quot;Cache-Control:
2906 # public, max-age=[TTL]&quot; header, regardless of any existing
2907 # Cache-Control header. The actual headers served in responses will not be
2908 # altered.
2909 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2910 &quot;A String&quot;,
2911 ],
2912 },
2913 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
2914 # backend service.
2915 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
2916 # as a count of seconds and fractions of seconds at nanosecond
2917 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2918 # or &quot;month&quot;. Range is approximately 10,000 years.
2919 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2920 # Durations less than one second are represented with a 0
2921 # `seconds` field and a positive `nanos` field. Must be from 0
2922 # to 999,999,999 inclusive.
2923 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2924 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2925 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2926 },
2927 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
2928 # there is no limit.
2929 #
2930 # Not supported when the backend service is referenced by a URL map that is
2931 # bound to target gRPC proxy that has validateForProxyless field set to true.
2932 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
2933 # not specified, there is no limit.
2934 #
2935 # Not supported when the backend service is referenced by a URL map that is
2936 # bound to target gRPC proxy that has validateForProxyless field set to true.
2937 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
2938 # service. If not specified, there is no limit.
2939 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
2940 # This parameter is respected by both the HTTP/1.1 and HTTP/2
2941 # implementations. If not specified, there is no limit. Setting this
2942 # parameter to 1 will effectively disable keep alive.
2943 #
2944 # Not supported when the backend service is referenced by a URL map that is
2945 # bound to target gRPC proxy that has validateForProxyless field set to true.
2946 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
2947 # not specified, the default is 1.
2948 #
2949 # Not supported when the backend service is referenced by a URL map that is
2950 # bound to target gRPC proxy that has validateForProxyless field set to true.
2951 },
2952 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2953 # the client&#x27;s Accept-Encoding header.
2954 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
2955 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
2956 # instance. For supported load balancers and protocols, as described inEnabling
2957 # connection draining.
2958 },
2959 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
2960 # tracking policy settings are only available for external passthrough
2961 # Network Load Balancers and internal passthrough Network Load Balancers.
2962 #
2963 # connectionTrackingPolicy cannot be specified with haPolicy.
2964 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
2965 # value is DEFAULT_FOR_PROTOCOL.
2966 #
2967 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
2968 # persist on unhealthy backends only for connection-oriented protocols
2969 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
2970 # Affinity is configured for 5-tuple. They do not persist forUDP.
2971 #
2972 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
2973 # the existing connections on the unhealthy backend are never persisted on
2974 # the unhealthy backend. They are always diverted to newly selected healthy
2975 # backends (unless all backends are unhealthy).
2976 #
2977 # If set to ALWAYS_PERSIST, existing connections always
2978 # persist on unhealthy backends regardless of protocol and session
2979 # affinity. It is generally not recommended to use this mode overriding the
2980 # default.
2981 #
2982 # For more details, see [Connection Persistence for Network Load
2983 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
2984 # and [Connection Persistence for Internal TCP/UDP Load
2985 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
2986 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
2987 # Balancers. This option is not available publicly.
2988 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
2989 # matching traffic (in seconds).
2990 #
2991 # For internal passthrough Network Load Balancers:
2992 #
2993 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
2994 # - It can be set only if Connection Tracking is less than 5-tuple
2995 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
2996 # Mode is PER_SESSION).
2997 #
2998 #
2999 #
3000 # For external passthrough Network Load Balancers the default is 60
3001 # seconds. This option is not available publicly.
3002 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
3003 # options:
3004 #
3005 # - PER_CONNECTION: This is the default mode. The Connection
3006 # Tracking is performed as per the Connection Key (default Hash Method) for
3007 # the specific protocol.
3008 # - PER_SESSION: The Connection Tracking is performed as per
3009 # the configured Session Affinity. It matches the configured Session
3010 # Affinity.
3011 #
3012 #
3013 #
3014 # For more details, see [Tracking Mode for Network Load
3015 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
3016 # and [Tracking Mode for Internal TCP/UDP Load
3017 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
3018 },
3019 &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
3020 # affinity based on HTTP headers, cookies or other properties. This load
3021 # balancing policy is applicable only for HTTP connections. The affinity to a
3022 # particular destination host will be lost when one or more hosts are
3023 # added/removed from the destination service. This field specifies parameters
3024 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
3025 #
3026 # This field is applicable to either:
3027 #
3028 # - A regional backend service with the service protocol set to HTTP,
3029 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3030 # INTERNAL_MANAGED.
3031 # - A global backend service with the
3032 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3033 &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
3034 # be used as the hash key for the consistent hash load balancer. If the
3035 # cookie is not present, it will be generated. This field is applicable if
3036 # the sessionAffinity is set to HTTP_COOKIE.
3037 #
3038 # Not supported when the backend service is referenced by a URL map that is
3039 # bound to target gRPC proxy that has validateForProxyless field set to true.
3040 # for load balancing policies that use a consistent hash.
3041 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3042 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3043 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3044 # as a count of seconds and fractions of seconds at nanosecond
3045 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3046 # or &quot;month&quot;. Range is approximately 10,000 years.
3047 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3048 # Durations less than one second are represented with a 0
3049 # `seconds` field and a positive `nanos` field. Must be from 0
3050 # to 999,999,999 inclusive.
3051 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3052 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3053 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3054 },
3055 },
3056 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
3057 # applicable if the sessionAffinity is set toHEADER_FIELD.
3058 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
3059 # 1024. Larger ring sizes result in more granular load distributions. If the
3060 # number of hosts in the load balancing pool is larger than the ring size,
3061 # each host will be assigned a single virtual node.
3062 },
3063 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3064 # text format.
3065 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
3066 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
3067 # locality_lb_policy.
3068 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
3069 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
3070 # long and match the regular expression
3071 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
3072 # first character must be a lowercase letter, and all following
3073 # characters must be a dash, period, underscore, lowercase letter, or
3074 # digit, except the last character, which cannot be a dash, period, or
3075 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
3076 # field can only be used for a global or regional backend service with the
3077 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
3078 },
3079 ],
3080 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
3081 # custom
3082 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
3083 &quot;A String&quot;,
3084 ],
3085 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
3086 # custom
3087 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
3088 &quot;A String&quot;,
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;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
3093 # backend service with dynamic forwarding feature which together with Service
3094 # Extension allows customized and complex routing logic.
3095 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
3096 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
3097 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
3098 },
3099 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
3100 # service. Some ranges are restricted: Restricted
3101 # ranges.
3102 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
3103 },
3104 },
3105 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
3106 # this backend service.
3107 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
3108 # global external Application Load Balancer.
3109 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
3110 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
3111 #
3112 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
3113 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
3114 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
3115 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
3116 # externalManagedMigrationTestingPercentage.
3117 #
3118 # Rolling back a migration requires the states to be set in reverse order. So
3119 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
3120 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
3121 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
3122 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
3123 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
3124 # external Application Load Balancer.
3125 #
3126 # The value of this field must be in the range [0, 100].
3127 #
3128 # Session affinity options will slightly affect this routing behavior, for
3129 # more details, see:Session
3130 # Affinity.
3131 #
3132 # This value can only be set if the loadBalancingScheme in the BackendService
3133 # is set to EXTERNAL (when using the classic Application Load Balancer) and
3134 # the migration state is TEST_BY_PERCENTAGE.
3135 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
3136 # as a backup (failover) backend.
3137 # For load balancers that have configurable failover:
3138 # [Internal passthrough Network Load
3139 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3140 # and [external passthrough Network Load
3141 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3142 #
3143 # failoverPolicy cannot be specified with haPolicy.
3144 # failover:
3145 # [Internal passthrough Network Load
3146 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3147 # and [external passthrough
3148 # Network Load
3149 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3150 # On failover or failback, this field indicates whether connection draining
3151 # will be honored. Google Cloud has a fixed connection draining timeout of
3152 # 10 minutes. A setting of true terminates existing TCP
3153 # connections to the active pool during failover and failback, immediately
3154 # draining traffic. A setting of false allows existing TCP
3155 # connections to persist, even on VMs no longer in the active pool, for up
3156 # to the duration of the connection draining timeout (10 minutes).
3157 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
3158 #
3159 # The default is false.
3160 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
3161 # load balancer are dropped when all primary and all backup backend VMs are
3162 # unhealthy.If set to false, connections are distributed
3163 # among all primary VMs when all primary and all backup backend VMs are
3164 # unhealthy.
3165 # For load balancers that have configurable
3166 # failover:
3167 # [Internal passthrough
3168 # Network Load
3169 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3170 # and [external passthrough
3171 # Network Load
3172 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3173 # The default is false.
3174 &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
3175 # failover when the number of healthy primary VMs equals zero.
3176 # For all other values, the load balancer performs a failover when the
3177 # total number of healthy primary VMs is less than this ratio.
3178 # For load balancers that have configurable
3179 # failover:
3180 # [Internal TCP/UDP Load
3181 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3182 # and [external TCP/UDP Load
3183 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3184 },
3185 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
3186 # This field is used in optimistic locking. This field will be ignored when
3187 # inserting a BackendService. An up-to-date fingerprint must be provided in
3188 # order to update the BackendService, otherwise the request will
3189 # fail with error 412 conditionNotMet.
3190 #
3191 # To see the latest fingerprint, make a get() request to
3192 # retrieve a BackendService.
3193 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
3194 # Protocol Forwarding.
3195 #
3196 # The backends of this regional backend service must only specify zonal
3197 # network endpoint groups (NEGs) of type GCE_VM_IP.
3198 #
3199 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
3200 # regional backend service must set the network field. All zonal NEGs must
3201 # belong to the same network. However, individual NEGs can
3202 # belong to different subnetworks of that network.
3203 #
3204 # When haPolicy is specified, the set of attached network endpoints across
3205 # all backends comprise an High Availability domain from which one endpoint
3206 # is selected as the active endpoint (the leader) that receives all
3207 # traffic.
3208 #
3209 # haPolicy can be added only at backend service creation time. Once set up,
3210 # it cannot be deleted.
3211 #
3212 # Note that haPolicy is not for load balancing, and therefore cannot be
3213 # specified with sessionAffinity, connectionTrackingPolicy, and
3214 # failoverPolicy.
3215 #
3216 # haPolicy requires customers to be responsible for tracking backend
3217 # endpoint health and electing a leader among the healthy endpoints.
3218 # Therefore, haPolicy cannot be specified with healthChecks.
3219 #
3220 # haPolicy can only be specified for External Passthrough Network Load
3221 # Balancers and Internal Passthrough Network Load Balancers.
3222 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
3223 # achieve it.
3224 #
3225 # Supported values are:
3226 #
3227 # - DISABLED: Fast IP Move is disabled. You can only use the
3228 # haPolicy.leader API to update the leader.
3229 # - &gt;GARP_RA: Provides a method to very quickly define a new network
3230 # endpoint as the leader. This method is faster than updating the leader
3231 # using the haPolicy.leader API. Fast IP move works as follows: The VM
3232 # hosting the network endpoint that should become the new leader sends
3233 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
3234 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
3235 # temporarily associates the forwarding rule IP address with that VM, and
3236 # both new and in-flight packets are quickly delivered to that VM.
3237 #
3238 #
3239 #
3240 # Note the important properties of the Fast IP Move functionality:
3241 #
3242 # - The GARP/RA-initiated re-routing stays active for approximately 20
3243 # minutes. After triggering fast failover, you must also
3244 # appropriately set the haPolicy.leader.
3245 # - The new leader instance should continue to send GARP/RA packets
3246 # periodically every 10 seconds until at least 10 minutes after updating
3247 # the haPolicy.leader (but stop immediately if it is no longer the leader).
3248 # - After triggering a fast failover, we recommend that you wait at least
3249 # 3 seconds before sending another GARP/RA packet from a different VM
3250 # instance to avoid race conditions.
3251 # - Don&#x27;t send GARP/RA packets from different VM
3252 # instances at the same time. If multiple instances continue to send
3253 # GARP/RA packets, traffic might be routed to different destinations in an
3254 # alternating order. This condition ceases when a single instance
3255 # issues a GARP/RA packet.
3256 # - The GARP/RA request always takes priority over the leader API.
3257 # Using the haPolicy.leader API to change the leader to a different
3258 # instance will have no effect until the GARP/RA request becomes
3259 # inactive.
3260 # - The GARP/RA packets should follow the GARP/RA
3261 # Packet Specifications..
3262 # - When multiple forwarding rules refer to a regional backend service,
3263 # you need only send a GARP or RA packet for a single forwarding rule
3264 # virtual IP. The virtual IPs for all forwarding rules targeting the same
3265 # backend service will also be moved to the sender of the GARP or RA
3266 # packet.
3267 #
3268 #
3269 #
3270 # The following are the Fast IP Move limitations (that is, when fastIPMove
3271 # is not DISABLED):
3272 #
3273 # - Multiple forwarding rules cannot use the same IP address if one of
3274 # them refers to a regional backend service with fastIPMove.
3275 # - The regional backend service must set the network field, and all
3276 # NEGs must belong to that network. However, individual
3277 # NEGs can belong to different subnetworks of that network.
3278 # - The maximum number of network endpoints across all backends of a
3279 # backend service with fastIPMove is 32.
3280 # - The maximum number of backend services with fastIPMove that can have
3281 # the same network endpoint attached to one of its backends is 64.
3282 # - The maximum number of backend services with fastIPMove in a VPC in a
3283 # region is 64.
3284 # - The network endpoints that are attached to a backend of a backend
3285 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
3286 # - Traffic directed to the leader by a static route next hop will not be
3287 # redirected to a new leader by fast failover. Such traffic will only be
3288 # redirected once an haPolicy.leader update has taken effect. Only traffic
3289 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
3290 # fast failover.
3291 #
3292 #
3293 # haPolicy.fastIPMove can be set only at backend service creation time.
3294 # Once set, it cannot be updated.
3295 #
3296 # By default, fastIpMove is set to DISABLED.
3297 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
3298 # this service as the active endpoint (the leader) that receives all
3299 # traffic.
3300 #
3301 # When the leader changes, there is no connection draining to persist
3302 # existing connections on the old leader.
3303 #
3304 # You are responsible for selecting a suitable endpoint as the
3305 # leader. For example, preferring a healthy endpoint over unhealthy ones.
3306 # Note that this service does not track backend endpoint health, and
3307 # selects the configured leader unconditionally.
3308 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
3309 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
3310 # that the leader is attached to.
3311 #
3312 # The leader&#x27;s backendGroup must already be specified as a backend of
3313 # this backend service. Removing a backend that is designated as the
3314 # leader&#x27;s backendGroup is not permitted.
3315 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
3316 # designated as the leader.
3317 #
3318 # This network endpoint cannot be detached from the NEG specified in
3319 # the haPolicy.leader.backendGroup until the leader is updated with
3320 # another network endpoint, or the leader is removed from the haPolicy.
3321 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
3322 # instance must already be attached to the NEG specified in the
3323 # haPolicy.leader.backendGroup.
3324 #
3325 # The name must be 1-63 characters long, and comply with RFC1035.
3326 # Authorization requires the following IAM permission on the
3327 # specified resource instance: compute.instances.use
3328 },
3329 },
3330 },
3331 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
3332 # httpsHealthChecks (legacy) resource for health checking this backend
3333 # service. Not all backend services support legacy health checks. See
3334 # Load balancer guide. Currently, at most one health check can be
3335 # specified for each backend service. Backend services with
3336 # instance group or zonal NEG backends must have a health check unless
3337 # haPolicy is specified. Backend services with internet or serverless NEG
3338 # backends must not have a health check.
3339 #
3340 # healthChecks[] cannot be specified with haPolicy.
3341 &quot;A String&quot;,
3342 ],
3343 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
3344 # Not available for internal passthrough Network Load Balancers and external
3345 # passthrough Network Load Balancers.
3346 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
3347 # incoming requests.
3348 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
3349 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
3350 # For security reasons, this value cannot be retrieved via the API.
3351 # Instead, the SHA-256 hash of the value is returned in the
3352 # oauth2ClientSecretSha256 field.
3353 #
3354 # @InputOnly
3355 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
3356 },
3357 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3358 # defined by the server.
3359 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
3360 # from the client to the backend for proxyless gRPC).
3361 # The possible values are:
3362 #
3363 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
3364 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3365 # Group), regardless of traffic from the client to the proxy. Only IPv4
3366 # health checks are used to check the health of the backends. This is the
3367 # default setting.
3368 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
3369 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
3370 # address).
3371 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
3372 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3373 # Group), regardless of traffic from the client to the proxy. Only IPv6
3374 # health checks are used to check the health of the backends.
3375 #
3376 #
3377 #
3378 # This field is applicable to either:
3379 #
3380 # - Advanced global external Application Load Balancer (load balancing
3381 # scheme EXTERNAL_MANAGED),
3382 # - Regional external Application Load
3383 # Balancer,
3384 # - Internal proxy Network Load Balancer (load balancing
3385 # scheme INTERNAL_MANAGED),
3386 # - Regional internal Application Load
3387 # Balancer (load balancing scheme INTERNAL_MANAGED),
3388 # - Traffic
3389 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
3390 # INTERNAL_SELF_MANAGED).
3391 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
3392 # for backend services.
3393 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
3394 # created for one type of load balancer cannot be used with another.
3395 # For more information, refer toChoosing
3396 # a load balancer.
3397 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
3398 # preference. When you use localityLbPolicies, you must set at least one
3399 # value for either the localityLbPolicies[].policy or the
3400 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
3401 # value set in the localityLbPolicy field.
3402 #
3403 # For an example of how to use this field, seeDefine
3404 # a list of preferred policies.
3405 #
3406 # Caution: This field and its children are intended for use in a service mesh
3407 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
3408 # that have this configuration.
3409 { # Container for either a built-in LB policy supported by gRPC or Envoy or
3410 # a custom one implemented by the end user.
3411 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
3412 # deployed with the client.
3413 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
3414 # by a locally installed custom policy implementation.
3415 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
3416 #
3417 # The value should match the name of a custom implementation registered
3418 # on the gRPC clients. It should follow protocol buffer message naming
3419 # conventions and include the full path (for example,
3420 # myorg.CustomLbPolicy). The maximum length is 256 characters.
3421 #
3422 # Do not specify the same custom policy more than once for a
3423 # backend. If you do, the configuration is rejected.
3424 #
3425 # For an example of how to use this field, seeUse
3426 # a custom policy.
3427 },
3428 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
3429 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
3430 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
3431 # about these values, see the description of localityLbPolicy.
3432 #
3433 # Do not specify the same policy more than once for a
3434 # backend. If you do, the configuration is rejected.
3435 },
3436 },
3437 ],
3438 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
3439 # possible values are:
3440 #
3441 # - ROUND_ROBIN: This is a simple policy in which each healthy
3442 # backend is selected in round robin order. This is the default.
3443 # - LEAST_REQUEST: An O(1) algorithm which
3444 # selects two random healthy hosts and picks the host which has fewer active
3445 # requests.
3446 # - RING_HASH: The ring/modulo hash load balancer implements
3447 # consistent hashing to backends. The algorithm has the property that the
3448 # addition/removal of a host from a set of N hosts only affects 1/N of the
3449 # requests.
3450 # - RANDOM: The load balancer selects a random healthy
3451 # host.
3452 # - ORIGINAL_DESTINATION: Backend host is selected
3453 # based on the client connection metadata, i.e., connections are opened to
3454 # the same address as the destination address of the incoming connection
3455 # before the connection was redirected to the load balancer.
3456 # - MAGLEV: used as a drop in replacement for the ring hash
3457 # load balancer. Maglev is not as stable as ring hash but has faster table
3458 # lookup build times and host selection times. For more information about
3459 # Maglev, see Maglev:
3460 # A Fast and Reliable Software Network Load Balancer.
3461 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
3462 # Load Balancing using weights computed from Backend reported Custom Metrics.
3463 # If set, the Backend Service responses are expected to contain non-standard
3464 # HTTP response header field Endpoint-Load-Metrics. The reported
3465 # metrics to use for computing the weights are specified via thecustomMetrics field.
3466 #
3467 # This field is applicable to either:
3468 # - A regional backend service with the service protocol set to HTTP,
3469 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3470 # INTERNAL_MANAGED.
3471 # - A global backend service with the
3472 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
3473 # EXTERNAL_MANAGED.
3474 #
3475 #
3476 # If sessionAffinity is not configured—that is, if session
3477 # affinity remains at the default value of NONE—then the
3478 # default value for localityLbPolicy
3479 # is ROUND_ROBIN. If session affinity is set to a value other
3480 # than NONE,
3481 # then the default value for localityLbPolicy isMAGLEV.
3482 #
3483 # Only ROUND_ROBIN and RING_HASH are supported
3484 # when the backend service is referenced by a URL map that is bound to
3485 # target gRPC proxy that has validateForProxyless field set to true.
3486 #
3487 # localityLbPolicy cannot be specified with haPolicy.
3488 &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
3489 # by this backend service. If logging is enabled, logs will be exported to
3490 # Stackdriver.
3491 # backend service.
3492 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
3493 # traffic served by this backend service. The default value is false.
3494 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
3495 { # Determines which HTTP headers will be logged to Stackdriver.
3496 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3497 },
3498 ],
3499 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
3500 { # Determines which HTTP headers will be logged to Stackdriver.
3501 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3502 },
3503 ],
3504 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
3505 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
3506 # of optional fields you want to include in the logs. For example:
3507 # serverInstance, serverGkeDetails.cluster,
3508 # serverGkeDetails.pod.podNamespace
3509 &quot;A String&quot;,
3510 ],
3511 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
3512 # service. Configures whether all, none or a subset of optional fields
3513 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3514 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3515 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
3516 # service. The value of the field must be in [0, 1]. This configures the
3517 # sampling rate of requests to the load balancer where 1.0 means all logged
3518 # requests are reported and 0.0 means no logged requests are reported. The
3519 # default value is 1.0.
3520 },
3521 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
3522 # service. Duration is computed from the beginning of the stream until the
3523 # response has been completely processed, including all retries. A stream
3524 # that does not complete in this duration is closed.
3525 #
3526 # If not specified, there will be no timeout limit, i.e. the maximum
3527 # duration is infinite.
3528 #
3529 # This value can be overridden in the PathMatcher configuration of the
3530 # UrlMap that references this backend service.
3531 #
3532 # This field is only allowed when the loadBalancingScheme of
3533 # the backend service is INTERNAL_SELF_MANAGED.
3534 # as a count of seconds and fractions of seconds at nanosecond
3535 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3536 # or &quot;month&quot;. Range is approximately 10,000 years.
3537 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3538 # Durations less than one second are represented with a 0
3539 # `seconds` field and a positive `nanos` field. Must be from 0
3540 # to 999,999,999 inclusive.
3541 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3542 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3543 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3544 },
3545 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
3546 # controller and read by the backend RCTH
3547 &quot;a_key&quot;: &quot;A String&quot;,
3548 },
3549 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3550 # The name must be 1-63 characters long, and comply withRFC1035.
3551 # Specifically, the name must be 1-63 characters long and match the regular
3552 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3553 # character must be a lowercase letter, and all following characters must
3554 # be a dash, lowercase letter, or digit, except the last character, which
3555 # cannot be a dash.
3556 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
3557 #
3558 # This field must be set for Internal Passthrough Network Load Balancers when
3559 # the haPolicy is enabled, and for External Passthrough Network Load
3560 # Balancers when the haPolicy fastIpMove is enabled.
3561 #
3562 # 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.
3563 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
3564 # Load Balancers.
3565 #
3566 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
3567 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
3568 # endpoints in the local zone.
3569 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
3570 # possible values are:
3571 #
3572 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
3573 # is disabled. The load balancer distributes new connections to all
3574 # healthy backend endpoints across all zones.
3575 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
3576 # enabled. The load balancer distributes new connections to all healthy
3577 # backend endpoints in the local zone only. If there are no healthy
3578 # backend endpoints in the local zone, the load balancer distributes
3579 # new connections to all backend endpoints in the local zone.
3580 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
3581 # enabled. The load balancer distributes new connections to all healthy
3582 # backend endpoints in the local zone only. If there aren&#x27;t enough
3583 # healthy backend endpoints in the local zone, the load balancer
3584 # distributes new connections to all healthy backend endpoints across all
3585 # zones.
3586 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
3587 # of healthy backend endpoints in a zone to the count of backend
3588 # endpoints in that same zone is equal to or above this threshold, the
3589 # load balancer distributes new connections to all healthy endpoints in
3590 # the local zone only. When the ratio of the count of healthy backend
3591 # endpoints in a zone to the count of backend endpoints in that same
3592 # zone is below this threshold, the load balancer distributes all new
3593 # connections to all healthy endpoints across all zones.
3594 },
3595 },
3596 &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.
3597 # the backend service.
3598 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
3599 # service.
3600 },
3601 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
3602 # load balancing pool of each individual proxy instance that processes the
3603 # traffic for the given backend service. If not set, this feature is
3604 # considered disabled.
3605 #
3606 # Results of the outlier detection algorithm (ejection of endpoints from the
3607 # load balancing pool and returning them back to the pool) are executed
3608 # independently by each proxy instance of the load balancer. In most cases,
3609 # more than one proxy instance handles the traffic received by a backend
3610 # service. Thus, it is possible that an unhealthy endpoint is detected and
3611 # ejected by only some of the proxies, and while this happens, other proxies
3612 # may continue to send requests to the same unhealthy endpoint until they
3613 # detect and eject the unhealthy endpoint.
3614 #
3615 # Applicable backend endpoints can be:
3616 #
3617 # - VM instances in an Instance Group
3618 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
3619 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
3620 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
3621 # Functions Services
3622 # - Private Service Connect NEGs, that resolve to
3623 # Google-managed regional API endpoints or managed services published using
3624 # Private Service Connect
3625 #
3626 #
3627 #
3628 # Applicable backend service types can be:
3629 #
3630 # - A global backend service with the loadBalancingScheme set to
3631 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
3632 # - A regional backend
3633 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
3634 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
3635 # supported for Serverless NEGs.
3636 #
3637 #
3638 #
3639 # Not supported when the backend service is referenced by a URL map that is
3640 # bound to target gRPC proxy that has validateForProxyless field set to true.
3641 # pool for the backend service.
3642 &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
3643 # or 30s.
3644 #
3645 # After a backend endpoint is returned back to the load balancing pool, it
3646 # can be ejected again in another ejection analysis. Thus, the total ejection
3647 # time is equal to the base ejection time multiplied by the number of times
3648 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
3649 # as a count of seconds and fractions of seconds at nanosecond
3650 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3651 # or &quot;month&quot;. Range is approximately 10,000 years.
3652 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3653 # Durations less than one second are represented with a 0
3654 # `seconds` field and a positive `nanos` field. Must be from 0
3655 # to 999,999,999 inclusive.
3656 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3657 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3658 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3659 },
3660 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
3661 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
3662 # return code qualifies as an error. Defaults to 5.
3663 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
3664 # connection errors that are mapped to one of those status codes) before a
3665 # consecutive gateway failure ejection occurs. Defaults to 3.
3666 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3667 # outlier status is detected through consecutive 5xx. This setting can be
3668 # used to disable ejection or to ramp it up slowly. Defaults to 0.
3669 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3670 # outlier status is detected through consecutive gateway failures. This
3671 # setting can be used to disable ejection or to ramp it up slowly. Defaults
3672 # to 100.
3673 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3674 # outlier status is detected through success rate statistics. This setting
3675 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
3676 #
3677 # Not supported when the backend service uses Serverless NEG.
3678 &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
3679 # ejections and backend endpoints being returned to service. The interval is
3680 # equal to the number of seconds as defined in
3681 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
3682 # in outlierDetection.interval.nanos. Defaults to 1 second.
3683 # as a count of seconds and fractions of seconds at nanosecond
3684 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3685 # or &quot;month&quot;. Range is approximately 10,000 years.
3686 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3687 # Durations less than one second are represented with a 0
3688 # `seconds` field and a positive `nanos` field. Must be from 0
3689 # to 999,999,999 inclusive.
3690 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3691 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3692 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3693 },
3694 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
3695 # backend service that can be ejected if the ejection conditions are met.
3696 # Defaults to 50%.
3697 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
3698 # enough request volume to detect success rate outliers. If the number of
3699 # backend endpoints is fewer than this setting, outlier detection via success
3700 # rate statistics is not performed for any backend endpoint in the load
3701 # balancing pool. Defaults to 5.
3702 #
3703 # Not supported when the backend service uses Serverless NEG.
3704 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
3705 # (as defined by the interval duration above) to include this backend
3706 # endpoint in success rate based outlier detection. If the volume is lower
3707 # than this setting, outlier detection via success rate statistics is not
3708 # performed for that backend endpoint. Defaults to 100.
3709 #
3710 # Not supported when the backend service uses Serverless NEG.
3711 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
3712 # outlier ejection. The ejection threshold is the difference between the mean
3713 # success rate, and the product of this factor and the standard deviation of
3714 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
3715 # is divided by a thousand to get a double. That is, if the desired factor
3716 # is 1.9, the runtime value should be 1900. Defaults to 1900.
3717 #
3718 # Not supported when the backend service uses Serverless NEG.
3719 },
3720 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3721 # as part of resource payload.
3722 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3723 # Tag keys and values have the same definition as resource
3724 # manager tags. The field is allowed for INSERT
3725 # only. The keys/values to set on the resource should be specified in
3726 # either ID { : } or Namespaced format
3727 # { : }.
3728 # For example the following are valid inputs:
3729 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3730 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3731 # Note:
3732 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3733 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3734 &quot;a_key&quot;: &quot;A String&quot;,
3735 },
3736 },
3737 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
3738 # the backend. The default value is 80.
3739 # For internal passthrough Network Load Balancers and external passthrough
3740 # Network Load Balancers, omit port.
3741 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
3742 # communication to the backend VMs in that group. The
3743 # named port must be [defined on each backend instance
3744 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
3745 # This parameter has no meaning if the backends are NEGs. For internal
3746 # passthrough Network Load Balancers and external passthrough Network Load
3747 # Balancers, omit port_name.
3748 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
3749 # with backends.
3750 #
3751 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
3752 # depending on the chosen load balancer or Traffic Director configuration.
3753 # Refer to the documentation for the load balancers or for Traffic Director
3754 # for more information.
3755 #
3756 # Must be set to GRPC when the backend service is referenced by a URL map
3757 # that is bound to target gRPC proxy.
3758 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
3759 # resides. This field is not applicable to global backend services.
3760 # You must specify this field as part of the HTTP request URL. It is
3761 # not settable as a field in the request body.
3762 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
3763 # backend service.
3764 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
3765 # service. This field is applicable to a global backend service with the
3766 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3767 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
3768 &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
3769 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
3770 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
3771 # private storage buckets that support Signature Version 4 for authentication.
3772 # The service name for generating the authentication header will always default
3773 # to &#x27;s3&#x27;.
3774 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
3775 # creating a backend that uses AWS v4 signature authentication, but will not
3776 # be returned as part of the configuration when queried with a REST API GET
3777 # request.
3778 #
3779 # @InputOnly
3780 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
3781 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
3782 # keep track of different iterations of your access key.
3783 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
3784 # the name of the region your cloud uses to host your origin. For example,
3785 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
3786 },
3787 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
3788 # that describes how clients should authenticate with this service&#x27;s
3789 # backends.
3790 #
3791 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
3792 # to INTERNAL_SELF_MANAGED.
3793 #
3794 # If left blank, communications are not encrypted.
3795 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
3796 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
3797 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
3798 # specified values, the communication continues. Otherwise, it fails. This
3799 # additional check enables the client to verify that the server is authorized
3800 # to run the requested service.
3801 #
3802 # Note that the contents of the server
3803 # certificate&#x27;s subjectAltName field are configured by the
3804 # Public Key Infrastructure which provisions server identities.
3805 #
3806 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
3807 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
3808 # mode).
3809 &quot;A String&quot;,
3810 ],
3811 },
3812 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3813 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
3814 #
3815 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
3816 # If set, lists of backends and health checks must be both empty.
3817 &quot;A String&quot;,
3818 ],
3819 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
3820 #
3821 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
3822 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
3823 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
3824 #
3825 # Only NONE and HEADER_FIELD are supported
3826 # when the backend service is referenced by a URL map that is bound to
3827 # target gRPC proxy that has validateForProxyless field set to true.
3828 #
3829 # For more details, see:
3830 # [Session
3831 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
3832 #
3833 # sessionAffinity cannot be specified with haPolicy.
3834 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
3835 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
3836 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3837 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3838 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3839 # as a count of seconds and fractions of seconds at nanosecond
3840 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3841 # or &quot;month&quot;. Range is approximately 10,000 years.
3842 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3843 # Durations less than one second are represented with a 0
3844 # `seconds` field and a positive `nanos` field. Must be from 0
3845 # to 999,999,999 inclusive.
3846 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3847 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3848 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3849 },
3850 },
3851 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
3852 # Currently this is applicable only for Internal TCP/UDP load balancing,
3853 # Internal HTTP(S) load balancing and Traffic Director.
3854 &quot;policy&quot;: &quot;A String&quot;,
3855 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
3856 # each service mesh client.
3857 #
3858 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
3859 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
3860 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
3861 # `INTERNAL_SELF_MANAGED`.
3862 #
3863 # `subset_size` is optional for Internal HTTP(S) load balancing
3864 # and required for Traffic Director.
3865 #
3866 # If you do not provide this value, Cloud Load Balancing will calculate it
3867 # dynamically to optimize the number of proxies/clients visible to each
3868 # backend and vice versa.
3869 #
3870 # Must be greater than 0. If `subset_size` is larger than the number of
3871 # backends/endpoints, then subsetting is disabled.
3872 },
3873 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
3874 # type of load balancer. For more information see,
3875 # Backend service settings.
3876 # The default is 30 seconds.
3877 # The full range of timeout values allowed goes from 1
3878 # through 2,147,483,647 seconds.
3879 #
3880 # This value can be overridden in the PathMatcher configuration of the
3881 # UrlMap that references this backend service.
3882 #
3883 # Not supported when the backend service is referenced by a URL map that is
3884 # bound to target gRPC proxy that has validateForProxyless field set to true.
3885 # Instead, use maxStreamDuration.
3886 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
3887 # when the backend protocol is SSL, HTTPS or HTTP2.
3888 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
3889 # networksecurity.googleapis.com namespace. Can be used in authenticating
3890 # TLS connections to the backend, as specified by the authenticationMode
3891 # field. Can only be specified if authenticationMode is not NONE.
3892 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
3893 #
3894 #
3895 # Use this property to configure the load balancer back-end to use
3896 # certificates and roots of trust provisioned by the Managed Workload
3897 # Identity system.
3898 #
3899 # The `identity` property is the
3900 # fully-specified SPIFFE ID to use in the SVID presented by the Load
3901 # Balancer Workload.
3902 #
3903 # The SPIFFE ID must be a resource starting with the
3904 # `trustDomain` property value, followed by the path to the Managed
3905 # Workload Identity.
3906 #
3907 # Supported SPIFFE ID format:
3908 #
3909 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
3910 #
3911 #
3912 # The Trust Domain within the Managed Identity must refer to a valid
3913 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
3914 # will be inherited from the Workload Identity Pool.
3915 #
3916 # Restrictions:
3917 #
3918 # - If you set the `identity` property, you cannot manually set
3919 # the following fields:
3920 # - tlsSettings.sni
3921 # - tlsSettings.subjectAltNames
3922 # - tlsSettings.authenticationConfig
3923 #
3924 #
3925 # When defining a `identity` for a RegionBackendServices, the
3926 # corresponding Workload Identity Pool must have a ca_pool
3927 # configured in the same region.
3928 #
3929 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
3930 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
3931 # balancer sends this string as the SNI hostname in the TLS connection to
3932 # the backend, and requires that this string match a Subject Alternative
3933 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
3934 # NEG backend, if the SNI is specified here, the load balancer uses it
3935 # regardless of whether the Regional Internet NEG is specified with FQDN or
3936 # IP address and port. When both sni and subjectAltNames[] are specified,
3937 # the load balancer matches the backend certificate&#x27;s SAN only to
3938 # subjectAltNames[].
3939 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
3940 # verifies during a TLS handshake with the backend. When the server
3941 # presents its X.509 certificate to the Load Balancer, the Load Balancer
3942 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
3943 # match one of the subjectAltNames in the list. This field is limited to 5
3944 # entries. When both sni and subjectAltNames[] are specified, the load
3945 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
3946 { # A Subject Alternative Name that the load balancer matches against the SAN
3947 # field in the TLS certificate provided by the backend, specified as either
3948 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
3949 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
3950 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
3951 },
3952 ],
3953 },
3954 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
3955 {
3956 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
3957 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
3958 # and ForwardingRule.
3959 },
3960 ],
3961 }</pre>
3962 </div>
3963
3964 <div class="method">
3965 <code class="details" id="getEffectiveSecurityPolicies">getEffectiveSecurityPolicies(project, backendService, x__xgafv=None)</code>
3966 <pre>Returns effective security policies applied to this backend service.
3967
3968 Args:
3969 project: string, Project ID for this request. (required)
3970 backendService: string, Name of the Backend Service for this request. (required)
3971 x__xgafv: string, V1 error format.
3972 Allowed values
3973 1 - v1 error format
3974 2 - v2 error format
3975
3976 Returns:
3977 An object of the form:
3978
3979 {
3980 &quot;securityPolicies&quot;: [ # Effective security policies for the backend service.
3981 { # Represents a Google Cloud Armor security policy resource.
3982 #
3983 # Only external backend services that use load balancers can
3984 # reference a security policy. For more information, see
3985 # Google Cloud Armor security policy overview.
3986 &quot;adaptiveProtectionConfig&quot;: { # Configuration options for Cloud Armor Adaptive Protection (CAAP).
3987 &quot;autoDeployConfig&quot;: { # Configuration options for Adaptive Protection auto-deploy feature.
3988 &quot;confidenceThreshold&quot;: 3.14,
3989 &quot;expirationSec&quot;: 42,
3990 &quot;impactedBaselineThreshold&quot;: 3.14,
3991 &quot;loadThreshold&quot;: 3.14,
3992 },
3993 &quot;layer7DdosDefenseConfig&quot;: { # Configuration options for L7 DDoS detection. # If set to true, enables Cloud Armor Machine Learning.
3994 # This field is only supported in Global Security Policies of type
3995 # CLOUD_ARMOR.
3996 &quot;enable&quot;: True or False, # If set to true, enables CAAP for L7 DDoS detection.
3997 # This field is only supported in Global Security Policies of type
3998 # CLOUD_ARMOR.
3999 &quot;ruleVisibility&quot;: &quot;A String&quot;, # Rule visibility can be one of the following:
4000 # STANDARD - opaque rules. (default)
4001 # PREMIUM - transparent rules.
4002 # This field is only supported in Global Security Policies of type
4003 # CLOUD_ARMOR.
4004 &quot;thresholdConfigs&quot;: [ # Configuration options for layer7 adaptive protection for various
4005 # customizable thresholds.
4006 {
4007 &quot;autoDeployConfidenceThreshold&quot;: 3.14,
4008 &quot;autoDeployExpirationSec&quot;: 42,
4009 &quot;autoDeployImpactedBaselineThreshold&quot;: 3.14,
4010 &quot;autoDeployLoadThreshold&quot;: 3.14,
4011 &quot;detectionAbsoluteQps&quot;: 3.14,
4012 &quot;detectionLoadThreshold&quot;: 3.14,
4013 &quot;detectionRelativeToBaselineQps&quot;: 3.14,
4014 &quot;name&quot;: &quot;A String&quot;, # The name must be 1-63 characters long, and comply withRFC1035.
4015 # The name must be unique within the security policy.
4016 &quot;trafficGranularityConfigs&quot;: [ # Configuration options for enabling Adaptive Protection to operate
4017 # on specified granular traffic units.
4018 { # Configurations to specifc granular traffic units processed by
4019 # Adaptive Protection.
4020 &quot;enableEachUniqueValue&quot;: True or False, # If enabled, traffic matching each unique value for the specified
4021 # type constitutes a separate traffic unit.
4022 # It can only be set to true if `value` is empty.
4023 &quot;type&quot;: &quot;A String&quot;, # Type of this configuration.
4024 &quot;value&quot;: &quot;A String&quot;, # Requests that match this value constitute a granular traffic unit.
4025 },
4026 ],
4027 },
4028 ],
4029 },
4030 },
4031 &quot;advancedOptionsConfig&quot;: {
4032 &quot;jsonCustomConfig&quot;: { # Custom configuration to apply the JSON parsing. Only applicable when
4033 # json_parsing is set to STANDARD.
4034 &quot;contentTypes&quot;: [ # A list of custom Content-Type header values to apply the JSON parsing.
4035 #
4036 # As per RFC 1341, a Content-Type header value has the following format:
4037 #
4038 # Content-Type := type &quot;/&quot; subtype *[&quot;;&quot; parameter]
4039 #
4040 # When configuring a custom Content-Type header value, only the
4041 # type/subtype needs to be specified, and the parameters should be
4042 # excluded.
4043 &quot;A String&quot;,
4044 ],
4045 },
4046 &quot;jsonParsing&quot;: &quot;A String&quot;,
4047 &quot;logLevel&quot;: &quot;A String&quot;,
4048 &quot;requestBodyInspectionSize&quot;: &quot;A String&quot;, # The maximum request size chosen by the customer with Waf enabled.
4049 # Values supported are &quot;8KB&quot;, &quot;16KB, &quot;32KB&quot;, &quot;48KB&quot; and &quot;64KB&quot;.
4050 # Values are case insensitive.
4051 &quot;userIpRequestHeaders&quot;: [ # An optional list of case-insensitive request header names to use for
4052 # resolving the callers client IP address.
4053 &quot;A String&quot;,
4054 ],
4055 },
4056 &quot;associations&quot;: [ # A list of associations that belong to this policy.
4057 {
4058 &quot;attachmentId&quot;: &quot;A String&quot;, # The resource that the security policy is attached to.
4059 &quot;displayName&quot;: &quot;A String&quot;, # Output only. [Output Only] The display name of the security policy of the association.
4060 &quot;excludedFolders&quot;: [ # A list of folders to exclude from the security policy.
4061 &quot;A String&quot;,
4062 ],
4063 &quot;excludedProjects&quot;: [ # A list of projects to exclude from the security policy.
4064 &quot;A String&quot;,
4065 ],
4066 &quot;name&quot;: &quot;A String&quot;, # The name for an association.
4067 &quot;securityPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] The security policy ID of the association.
4068 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the security policy of the association.
4069 },
4070 ],
4071 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4072 # text format.
4073 &quot;ddosProtectionConfig&quot;: {
4074 &quot;ddosAdaptiveProtection&quot;: &quot;A String&quot;,
4075 &quot;ddosImpactedBaselineThreshold&quot;: 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs)
4076 # builds DDoS mitigations that minimize collateral damage. It quantifies
4077 # this as the fraction of a non-abuse baseline that&#x27;s inadvertently
4078 # blocked.
4079 #
4080 # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will
4081 # not be deployed. Using a lower value will prioritize keeping collateral
4082 # damage low, possibly at the cost of its effectiveness in rate limiting
4083 # some or all of the attack. It should typically be unset, so Advanced DDoS
4084 # (and Adaptive Protection) uses the best mitigation it can find. Setting
4085 # the threshold is advised if there are logs for false positive detections
4086 # with high collateral damage, and will cause Advanced DDoS to attempt to
4087 # find a less aggressive rule that satisfies the constraint. If a suitable
4088 # rule cannot be found, the system falls back to either no mitigation for
4089 # smaller attacks or broader network throttles for larger ones.
4090 &quot;ddosProtection&quot;: &quot;A String&quot;,
4091 },
4092 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4093 # create the resource.
4094 &quot;displayName&quot;: &quot;A String&quot;, # User-provided name of the organization security policy. The name should be
4095 # unique in the organization in which the security policy is created. This
4096 # should only be used when SecurityPolicyType is FIREWALL.
4097 # The name must be 1-63 characters long, and comply with
4098 # https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63
4099 # characters long and match the regular expression
4100 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4101 # lowercase letter, and all following characters must be a dash, lowercase
4102 # letter, or digit, except the last character, which cannot be a dash.
4103 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
4104 # the metadata&#x27;s contents and used for optimistic locking. The
4105 # fingerprint is initially generated by Compute Engine and changes after
4106 # every request to modify or update metadata. You must always provide an
4107 # up-to-date fingerprint hash in order to update or change metadata,
4108 # otherwise the request will fail with error412 conditionNotMet.
4109 #
4110 # To see the latest fingerprint, make get() request to the
4111 # security policy.
4112 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
4113 # defined by the server.
4114 &quot;kind&quot;: &quot;compute#securityPolicy&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies
4115 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this security policy, which
4116 # is essentially a hash of the labels set used for optimistic locking. The
4117 # fingerprint is initially generated by Compute Engine and changes after
4118 # every request to modify or update labels. You must always provide an
4119 # up-to-date fingerprint hash in order to update or change labels.
4120 #
4121 # To see the latest fingerprint, make get() request to the
4122 # security policy.
4123 &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.
4124 # Label values may be empty.
4125 &quot;a_key&quot;: &quot;A String&quot;,
4126 },
4127 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4128 # The name must be 1-63 characters long, and comply withRFC1035.
4129 # Specifically, the name must be 1-63 characters long and match the regular
4130 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4131 # character must be a lowercase letter, and all following characters must
4132 # be a dash, lowercase letter, or digit, except the last character, which
4133 # cannot be a dash.
4134 &quot;parent&quot;: &quot;A String&quot;, # Output only. [Output Only] The parent of the security policy.
4135 &quot;recaptchaOptionsConfig&quot;: {
4136 &quot;redirectSiteKey&quot;: &quot;A String&quot;, # An optional field to supply a reCAPTCHA site key to be used for all the
4137 # rules using the redirect action with the type of GOOGLE_RECAPTCHA under
4138 # the security policy. The specified site key needs to be created from the
4139 # reCAPTCHA API. The user is responsible for the validity of the specified
4140 # site key. If not specified, a Google-managed site key is used.
4141 # This field is only supported in Global Security Policies of type
4142 # CLOUD_ARMOR.
4143 },
4144 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional security policy
4145 # resides. This field is not applicable to global security policies.
4146 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Total count of all security policy rule tuples. A security
4147 # policy can not exceed a set number of tuples.
4148 &quot;rules&quot;: [ # A list of rules that belong to this policy.
4149 # There must always be a default rule which is a rule with priority
4150 # 2147483647 and match all condition (for the match condition this means
4151 # match &quot;*&quot; for srcIpRanges and for the networkMatch condition every field
4152 # must be either match &quot;*&quot; or not set). If no rules are provided when
4153 # creating a security policy, a default rule with action &quot;allow&quot; will be
4154 # added.
4155 { # Represents a rule that describes one or more match conditions along with
4156 # the action to be taken when traffic matches this condition (allow or deny).
4157 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the rule is matched.
4158 # The following are the valid actions:
4159 #
4160 # - allow: allow access to target.
4161 # - deny(STATUS): deny access to target, returns the
4162 # HTTP response code specified. Valid values for `STATUS`
4163 # are 403, 404, and 502.
4164 # - rate_based_ban: limit client traffic to the configured
4165 # threshold and ban the client if the traffic exceeds the threshold.
4166 # Configure parameters for this action in RateLimitOptions. Requires
4167 # rate_limit_options to be set.
4168 # - redirect: redirect to a different target. This can
4169 # either be an internal reCAPTCHA redirect, or an external URL-based
4170 # redirect via a 302 response. Parameters for this action can be configured
4171 # via redirectOptions. This action is only supported in Global Security
4172 # Policies of type CLOUD_ARMOR.
4173 # - throttle: limit
4174 # client traffic to the configured threshold. Configure parameters for this
4175 # action in rateLimitOptions. Requires rate_limit_options to be set for
4176 # this.
4177 # - fairshare (preview only): when traffic reaches the
4178 # threshold limit, requests from the clients matching this rule begin to be
4179 # rate-limited using the Fair Share algorithm. This action is only allowed
4180 # in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
4181 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4182 # create the resource.
4183 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies. This field may only be
4184 # specified when versioned_expr is set to FIREWALL.
4185 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
4186 # enabled, logs will be exported to the configured export destination in
4187 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
4188 # cannot enable logging on &quot;goto_next&quot; rules.
4189 #
4190 # This field may only be specified when the versioned_expr is set to
4191 # FIREWALL.
4192 &quot;headerAction&quot;: { # Optional, additional actions that are performed on headers.
4193 # This field is only supported in Global Security Policies of type
4194 # CLOUD_ARMOR.
4195 &quot;requestHeadersToAdds&quot;: [ # The list of request headers to add or overwrite if they&#x27;re already
4196 # present.
4197 {
4198 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to set.
4199 &quot;headerValue&quot;: &quot;A String&quot;, # The value to set the named header to.
4200 },
4201 ],
4202 },
4203 &quot;kind&quot;: &quot;compute#securityPolicyRule&quot;, # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
4204 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
4205 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
4206 # Exactly one field must be specified.
4207 &quot;config&quot;: { # The configuration options available when specifying versioned_expr.
4208 # This field must be specified if versioned_expr is specified and cannot
4209 # be specified if versioned_expr is not specified.
4210 &quot;destIpRanges&quot;: [ # CIDR IP address range.
4211 #
4212 # This field may only be specified when versioned_expr is set to
4213 # FIREWALL.
4214 &quot;A String&quot;,
4215 ],
4216 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
4217 #
4218 # This field may only be specified when versioned_expr is set to
4219 # FIREWALL.
4220 {
4221 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
4222 # required when creating a firewall rule. This value can either be
4223 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
4224 # protocol number.
4225 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
4226 # only applicable for UDP or TCP protocol. Each entry must be either
4227 # an integer or a range. If not specified, this rule applies to
4228 # connections through any port.
4229 #
4230 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
4231 #
4232 # This field may only be specified when versioned_expr is set to
4233 # FIREWALL.
4234 &quot;A String&quot;,
4235 ],
4236 },
4237 ],
4238 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
4239 # Maximum number of src_ip_ranges allowed is 10.
4240 &quot;A String&quot;,
4241 ],
4242 },
4243 &quot;expr&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # User defined CEVAL expression.
4244 # A CEVAL expression is used to specify match criteria such as origin.ip,
4245 # source.region_code and contents in the request header.
4246 # Expressions containing `evaluateThreatIntelligence` require a Cloud
4247 # Armor Enterprise subscription and are not supported in Edge Policies
4248 # nor in Regional Policies. Expressions containing
4249 # `evaluatePreconfiguredExpr(&#x27;sourceiplist-*&#x27;)` require a Cloud Armor
4250 # Enterprise subscription and are only supported in Global Security
4251 # Policies.
4252 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4253 # are documented at https://github.com/google/cel-spec.
4254 #
4255 # Example (Comparison):
4256 #
4257 # title: &quot;Summary size limit&quot;
4258 # description: &quot;Determines if a summary is less than 100 chars&quot;
4259 # expression: &quot;document.summary.size() &lt; 100&quot;
4260 #
4261 # Example (Equality):
4262 #
4263 # title: &quot;Requestor is owner&quot;
4264 # description: &quot;Determines if requestor is the document owner&quot;
4265 # expression: &quot;document.owner == request.auth.claims.email&quot;
4266 #
4267 # Example (Logic):
4268 #
4269 # title: &quot;Public documents&quot;
4270 # description: &quot;Determine whether the document should be publicly visible&quot;
4271 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4272 #
4273 # Example (Data Manipulation):
4274 #
4275 # title: &quot;Notification string&quot;
4276 # description: &quot;Create a notification string with a timestamp.&quot;
4277 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4278 #
4279 # The exact variables and functions that may be referenced within an expression
4280 # are determined by the service that evaluates it. See the service
4281 # documentation for additional information.
4282 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4283 # describes the expression, e.g. when hovered over it in a UI.
4284 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4285 # syntax.
4286 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4287 # reporting, e.g. a file name and a position in the file.
4288 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4289 # its purpose. This can be used e.g. in UIs which allow to enter the
4290 # expression.
4291 },
4292 &quot;exprOptions&quot;: { # The configuration options available when specifying a user defined
4293 # CEVAL expression (i.e., &#x27;expr&#x27;).
4294 &quot;recaptchaOptions&quot;: { # reCAPTCHA configuration options to be applied for the rule. If the
4295 # rule does not evaluate reCAPTCHA tokens, this field has no effect.
4296 &quot;actionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
4297 # action-tokens. The provided site keys need to be created from
4298 # reCAPTCHA API under the same project where the security policy is
4299 # created.
4300 &quot;A String&quot;,
4301 ],
4302 &quot;sessionTokenSiteKeys&quot;: [ # A list of site keys to be used during the validation of reCAPTCHA
4303 # session-tokens. The provided site keys need to be created from
4304 # reCAPTCHA API under the same project where the security policy is
4305 # created.
4306 &quot;A String&quot;,
4307 ],
4308 },
4309 },
4310 &quot;versionedExpr&quot;: &quot;A String&quot;, # Preconfigured versioned expression.
4311 # If this field is specified, config must also be specified.
4312 # Available preconfigured expressions along with their requirements are:
4313 # SRC_IPS_V1 - must specify the corresponding src_ip_range field in
4314 # config.
4315 },
4316 &quot;networkMatch&quot;: { # Represents a match condition that incoming network traffic is evaluated # A match condition that incoming packets are evaluated against for
4317 # CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
4318 # &#x27;action&#x27; is enforced.
4319 #
4320 # The match criteria for a rule consists of built-in match fields (like
4321 # &#x27;srcIpRanges&#x27;) and potentially multiple user-defined match fields
4322 # (&#x27;userDefinedFields&#x27;).
4323 #
4324 # Field values may be extracted directly from the packet or derived from it
4325 # (e.g. &#x27;srcRegionCodes&#x27;). Some fields may not be present in every packet
4326 # (e.g. &#x27;srcPorts&#x27;). A user-defined field is only present if the base
4327 # header is found in the packet and the entire field is in bounds.
4328 #
4329 # Each match field may specify which values can match it, listing one or
4330 # more ranges, prefixes, or exact values that are considered a match for
4331 # the field. A field value must be present in order to match a specified
4332 # match field. If no match values are specified for a match field, then any
4333 # field value is considered to match it, and it&#x27;s not required to be
4334 # present. For strings specifying &#x27;*&#x27; is also equivalent to match all.
4335 #
4336 # For a packet to match a rule, all specified match fields must match the
4337 # corresponding field values derived from the packet.
4338 #
4339 # Example:
4340 #
4341 # networkMatch:
4342 # srcIpRanges:
4343 # - &quot;192.0.2.0/24&quot;
4344 # - &quot;198.51.100.0/24&quot;
4345 # userDefinedFields:
4346 # - name: &quot;ipv4_fragment_offset&quot;
4347 # values:
4348 # - &quot;1-0x1fff&quot;
4349 #
4350 # The above match condition matches packets with a source IP in
4351 # 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
4352 # &quot;ipv4_fragment_offset&quot; with a value between 1 and 0x1fff inclusive.
4353 # against.
4354 &quot;destIpRanges&quot;: [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text
4355 # format.
4356 &quot;A String&quot;,
4357 ],
4358 &quot;destPorts&quot;: [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
4359 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
4360 &quot;A String&quot;,
4361 ],
4362 &quot;ipProtocols&quot;: [ # IPv4 protocol / IPv6 next header (after extension headers). Each
4363 # element can be an 8-bit unsigned decimal number (e.g. &quot;6&quot;), range (e.g.
4364 # &quot;253-254&quot;), or one of the following protocol names: &quot;tcp&quot;, &quot;udp&quot;,
4365 # &quot;icmp&quot;, &quot;esp&quot;, &quot;ah&quot;, &quot;ipip&quot;, or &quot;sctp&quot;.
4366 &quot;A String&quot;,
4367 ],
4368 &quot;srcAsns&quot;: [ # BGP Autonomous System Number associated with the source IP address.
4369 42,
4370 ],
4371 &quot;srcIpRanges&quot;: [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
4372 &quot;A String&quot;,
4373 ],
4374 &quot;srcPorts&quot;: [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit
4375 # unsigned decimal number (e.g. &quot;80&quot;) or range (e.g. &quot;0-1023&quot;).
4376 &quot;A String&quot;,
4377 ],
4378 &quot;srcRegionCodes&quot;: [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source
4379 # IP address.
4380 &quot;A String&quot;,
4381 ],
4382 &quot;userDefinedFields&quot;: [ # User-defined fields. Each element names a defined field and lists the
4383 # matching values for that field.
4384 {
4385 &quot;name&quot;: &quot;A String&quot;, # Name of the user-defined field, as given in the definition.
4386 &quot;values&quot;: [ # Matching values of the field. Each element can be a 32-bit unsigned
4387 # decimal or hexadecimal (starting with &quot;0x&quot;) number (e.g. &quot;64&quot;) or
4388 # range (e.g. &quot;0x400-0x7ff&quot;).
4389 &quot;A String&quot;,
4390 ],
4391 },
4392 ],
4393 },
4394 &quot;preconfiguredWafConfig&quot;: { # Preconfigured WAF configuration to be applied for the rule. If the rule
4395 # does not evaluate preconfigured WAF rules, i.e., if
4396 # evaluatePreconfiguredWaf() is not used, this field will have no effect.
4397 &quot;exclusions&quot;: [ # A list of exclusions to apply during preconfigured WAF evaluation.
4398 {
4399 &quot;requestBodiesToExclude&quot;: [ # A list of request body fields to be excluded from inspection during
4400 # preconfigured WAF evaluation.
4401 {
4402 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
4403 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
4404 },
4405 ],
4406 &quot;requestCookiesToExclude&quot;: [ # A list of request cookie names whose value will be excluded from
4407 # inspection during preconfigured WAF evaluation.
4408 {
4409 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
4410 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
4411 },
4412 ],
4413 &quot;requestHeadersToExclude&quot;: [ # A list of request header names whose value will be excluded from
4414 # inspection during preconfigured WAF evaluation.
4415 {
4416 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
4417 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
4418 },
4419 ],
4420 &quot;requestQueryParamsToExclude&quot;: [ # A list of request query parameter names whose value will be excluded
4421 # from inspection during preconfigured WAF evaluation. Note that the
4422 # parameter can be in the query string or in the POST body.
4423 {
4424 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
4425 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
4426 },
4427 ],
4428 &quot;requestUrisToExclude&quot;: [ # A list of request URIs from the request line to be excluded from
4429 # inspection during preconfigured WAF evaluation. When specifying this
4430 # field, the query or fragment part should be excluded.
4431 {
4432 &quot;op&quot;: &quot;A String&quot;, # The match operator for the field.
4433 &quot;val&quot;: &quot;A String&quot;, # The value of the field.
4434 },
4435 ],
4436 &quot;targetRuleIds&quot;: [ # A list of target rule IDs under the WAF rule set to apply the
4437 # preconfigured WAF exclusion. If omitted, it refers to all the rule
4438 # IDs under the WAF rule set.
4439 &quot;A String&quot;,
4440 ],
4441 &quot;targetRuleSet&quot;: &quot;A String&quot;, # Target WAF rule set to apply the preconfigured WAF exclusion.
4442 },
4443 ],
4444 },
4445 &quot;preview&quot;: True or False, # If set to true, the specified action is not enforced.
4446 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
4447 # must be a positive value between 0 and 2147483647.
4448 # Rules are evaluated from highest to lowest priority where 0 is the
4449 # highest priority and 2147483647 is the lowest priority.
4450 &quot;rateLimitOptions&quot;: { # Must be specified if the action is &quot;rate_based_ban&quot; or &quot;throttle&quot; or
4451 # &quot;fairshare&quot;. Cannot be specified for any other actions.
4452 &quot;banDurationSec&quot;: 42, # Can only be specified if the action for the rule is
4453 # &quot;rate_based_ban&quot;. If specified, determines the time (in seconds)
4454 # the traffic will continue to be banned by the rate limit after the
4455 # rate falls below the threshold.
4456 &quot;banThreshold&quot;: { # Can only be specified if the action for the rule is
4457 # &quot;rate_based_ban&quot;. If specified, the key will be banned for the
4458 # configured &#x27;ban_duration_sec&#x27; when the number of requests that exceed
4459 # the &#x27;rate_limit_threshold&#x27; also exceed this &#x27;ban_threshold&#x27;.
4460 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
4461 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
4462 },
4463 &quot;conformAction&quot;: &quot;A String&quot;, # Action to take for requests that are under the configured rate limit
4464 # threshold. Valid option is &quot;allow&quot; only.
4465 &quot;enforceOnKey&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
4466 # values are:
4467 #
4468 # - ALL: A single rate limit threshold is applied to all
4469 # the requests matching this rule. This is the default value if
4470 # &quot;enforceOnKey&quot; is not configured.
4471 # - IP: The source IP address of
4472 # the request is the key. Each IP has this limit enforced
4473 # separately.
4474 # - HTTP_HEADER: The value of the HTTP
4475 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
4476 # value is truncated to the first 128 bytes of the header value. If no
4477 # such header is present in the request, the key type defaults toALL.
4478 # - XFF_IP: The first IP address (i.e. the
4479 # originating client IP address) specified in the list of IPs under
4480 # X-Forwarded-For HTTP header. If no such header is present or the value
4481 # is not a valid IP, the key defaults to the source IP address of
4482 # the request i.e. key type IP.
4483 # - HTTP_COOKIE: The value of the HTTP
4484 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
4485 # value is truncated to the first 128 bytes of the cookie value. If no
4486 # such cookie is present in the request, the key type defaults toALL.
4487 # - HTTP_PATH: The URL path of the HTTP request. The key
4488 # value is truncated to the first 128 bytes.
4489 # - SNI: Server name indication in the TLS session of the
4490 # HTTPS request. The key value is truncated to the first 128 bytes. The
4491 # key type defaults to ALL on a HTTP session.
4492 # - REGION_CODE: The country/region from which the request
4493 # originates.
4494 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
4495 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
4496 # key type defaults to ALL.
4497 # - USER_IP: The IP address of the originating client,
4498 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
4499 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration or
4500 # an IP address cannot be resolved from it, the key type defaults toIP.
4501 #
4502 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
4503 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
4504 # key type defaults to ALL.
4505 # For &quot;fairshare&quot; action, this value is limited to ALL i.e. a single rate
4506 # limit threshold is enforced for all the requests matching the rule.
4507 &quot;enforceOnKeyConfigs&quot;: [ # If specified, any combination of values of
4508 # enforce_on_key_type/enforce_on_key_name is treated as the key on which
4509 # ratelimit threshold/action is enforced. You can specify up to 3
4510 # enforce_on_key_configs. If enforce_on_key_configs is specified,
4511 # enforce_on_key must not be specified.
4512 {
4513 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
4514 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the
4515 # key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is
4516 # taken as the key value.
4517 &quot;enforceOnKeyType&quot;: &quot;A String&quot;, # Determines the key to enforce the rate_limit_threshold on. Possible
4518 # values are:
4519 #
4520 # - ALL: A single rate limit threshold is applied to all
4521 # the requests matching this rule. This is the default value if
4522 # &quot;enforceOnKeyConfigs&quot; is not configured.
4523 # - IP: The source IP address of
4524 # the request is the key. Each IP has this limit enforced
4525 # separately.
4526 # - HTTP_HEADER: The value of the HTTP
4527 # header whose name is configured under &quot;enforceOnKeyName&quot;. The key
4528 # value is truncated to the first 128 bytes of the header value. If no
4529 # such header is present in the request, the key type defaults toALL.
4530 # - XFF_IP: The first IP address (i.e. the
4531 # originating client IP address) specified in the list of IPs under
4532 # X-Forwarded-For HTTP header. If no such header is present or the
4533 # value is not a valid IP, the key defaults to the source IP address of
4534 # the request i.e. key type IP.
4535 # - HTTP_COOKIE: The value of the HTTP
4536 # cookie whose name is configured under &quot;enforceOnKeyName&quot;. The key
4537 # value is truncated to the first 128 bytes of the cookie value. If no
4538 # such cookie is present in the request, the key type defaults toALL.
4539 # - HTTP_PATH: The URL path of the HTTP request. The key
4540 # value is truncated to the first 128 bytes.
4541 # - SNI: Server name indication in the TLS session of
4542 # the HTTPS request. The key value is truncated to the first 128 bytes.
4543 # The key type defaults to ALL on a HTTP session.
4544 # - REGION_CODE: The country/region from which the
4545 # request originates.
4546 # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
4547 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
4548 # key type defaults to ALL.
4549 # - USER_IP: The IP address of the originating client,
4550 # which is resolved based on &quot;userIpRequestHeaders&quot; configured with the
4551 # security policy. If there is no &quot;userIpRequestHeaders&quot; configuration
4552 # or an IP address cannot be resolved from it, the key type defaults toIP.
4553 #
4554 # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
4555 # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
4556 # key type defaults to ALL.
4557 },
4558 ],
4559 &quot;enforceOnKeyName&quot;: &quot;A String&quot;, # Rate limit key name applicable only for the following key types:
4560 # HTTP_HEADER -- Name of the HTTP header whose value is taken as the key
4561 # value.
4562 # HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key
4563 # value.
4564 &quot;exceedAction&quot;: &quot;A String&quot;, # Action to take for requests that are above the configured rate limit
4565 # threshold, to either deny with a specified HTTP response code, or
4566 # redirect to a different endpoint.
4567 # Valid options are `deny(STATUS)`, where valid values for
4568 # `STATUS` are 403, 404, 429, and 502, and
4569 # `redirect`, where the redirect parameters come from
4570 # `exceedRedirectOptions` below.
4571 # The `redirect` action is only supported in Global Security Policies of
4572 # type CLOUD_ARMOR.
4573 &quot;exceedRedirectOptions&quot;: { # Parameters defining the redirect action that is used as the exceed
4574 # action. Cannot be specified if the exceed action is not redirect.
4575 # This field is only supported in Global Security Policies of type
4576 # CLOUD_ARMOR.
4577 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
4578 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
4579 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
4580 #
4581 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
4582 # challenge assessment.
4583 # - EXTERNAL_302: redirect to a different URL via a 302
4584 # response.
4585 },
4586 &quot;rateLimitThreshold&quot;: { # Threshold at which to begin ratelimiting.
4587 &quot;count&quot;: 42, # Number of HTTP(S) requests for calculating the threshold.
4588 &quot;intervalSec&quot;: 42, # Interval over which the threshold is computed.
4589 },
4590 },
4591 &quot;redirectOptions&quot;: { # Parameters defining the redirect action. Cannot be specified for any
4592 # other actions.
4593 # This field is only supported in Global Security Policies of type
4594 # CLOUD_ARMOR.
4595 &quot;target&quot;: &quot;A String&quot;, # Target for the redirect action. This is required if the type is
4596 # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
4597 &quot;type&quot;: &quot;A String&quot;, # Type of the redirect action. Possible values are:
4598 #
4599 # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual
4600 # challenge assessment.
4601 # - EXTERNAL_302: redirect to a different URL via a 302
4602 # response.
4603 },
4604 &quot;ruleNumber&quot;: &quot;A String&quot;, # Identifier for the rule. This is only unique within the given security
4605 # policy. This can only be set during rule creation, if rule number is not
4606 # specified it will be generated by the server.
4607 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall security
4608 # policy rule.
4609 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
4610 # allows you to control which network&#x27;s VMs get this rule. If this field
4611 # is left blank, all VMs within the organization will receive the rule.
4612 #
4613 # This field may only be specified when versioned_expr is set to FIREWALL.
4614 &quot;A String&quot;,
4615 ],
4616 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
4617 # applied with this rule.
4618 &quot;A String&quot;,
4619 ],
4620 },
4621 ],
4622 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
4623 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4624 &quot;shortName&quot;: &quot;A String&quot;, # User-provided name of the organization security policy. The name should be
4625 # unique in the organization in which the security policy is created. This
4626 # should only be used when SecurityPolicyType is CLOUD_ARMOR.
4627 # The name must be 1-63 characters long, and comply with
4628 # https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63
4629 # characters long and match the regular expression
4630 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
4631 # lowercase letter, and all following characters must be a dash, lowercase
4632 # letter, or digit, except the last character, which cannot be a dash.
4633 &quot;type&quot;: &quot;A String&quot;, # The type indicates the intended use of the security policy.
4634 #
4635 # - CLOUD_ARMOR: Cloud Armor backend security policies can
4636 # be configured to filter incoming HTTP requests targeting backend services.
4637 # They filter requests before they hit the origin servers.
4638 # - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can
4639 # be configured to filter incoming HTTP requests targeting backend services
4640 # (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage).
4641 # They filter requests before the request is served from Google&#x27;s cache.
4642 # - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor
4643 # internal service policies can be configured to filter HTTP requests
4644 # targeting services managed by Traffic Director in a service mesh. They
4645 # filter requests before the request is served from the application.
4646 #
4647 # - CLOUD_ARMOR_NETWORK: Cloud Armor network policies
4648 # can be configured to filter packets targeting network load balancing
4649 # resources such as backend services, target pools, target instances, and
4650 # instances with external IPs. They filter requests before the request is
4651 # served from the application.
4652 #
4653 #
4654 # This field can be set only at resource creation time.
4655 &quot;userDefinedFields&quot;: [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A
4656 # user-defined field consists of up to 4 bytes extracted from a fixed offset
4657 # in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an
4658 # optional mask to select certain bits. Rules may then specify matching
4659 # values for these fields.
4660 #
4661 # Example:
4662 #
4663 # userDefinedFields:
4664 # - name: &quot;ipv4_fragment_offset&quot;
4665 # base: IPV4
4666 # offset: 6
4667 # size: 2
4668 # mask: &quot;0x1fff&quot;
4669 {
4670 &quot;base&quot;: &quot;A String&quot;, # The base relative to which &#x27;offset&#x27; is measured. Possible values are:
4671 #
4672 # - IPV4: Points to the beginning of the IPv4 header.
4673 # - IPV6: Points to the beginning of the IPv6 header.
4674 # - TCP: Points to the beginning of the TCP header, skipping
4675 # over any IPv4 options or IPv6 extension headers. Not present for
4676 # non-first fragments.
4677 # - UDP: Points to the beginning of the UDP header, skipping
4678 # over any IPv4 options or IPv6 extension headers. Not present for
4679 # non-first fragments.
4680 #
4681 #
4682 # required
4683 &quot;mask&quot;: &quot;A String&quot;, # If specified, apply this mask (bitwise AND) to the field to ignore bits
4684 # before matching. Encoded as a hexadecimal number (starting with &quot;0x&quot;).
4685 # The last byte of the field (in network byte order) corresponds to the
4686 # least significant byte of the mask.
4687 &quot;name&quot;: &quot;A String&quot;, # The name of this field. Must be unique within the policy.
4688 &quot;offset&quot;: 42, # Offset of the first byte of the field (in network byte order) relative to
4689 # &#x27;base&#x27;.
4690 &quot;size&quot;: 42, # Size of the field in bytes. Valid values: 1-4.
4691 },
4692 ],
4693 },
4694 ],
4695 }</pre>
4696 </div>
4697
4698 <div class="method">
4699 <code class="details" id="getHealth">getHealth(project, backendService, body=None, x__xgafv=None)</code>
4700 <pre>Gets the most recent health check results for this
4701 BackendService.
4702
4703 Example request body:
4704
4705 {
4706 &quot;group&quot;: &quot;/zones/us-east1-b/instanceGroups/lb-backend-example&quot;
4707 }
4708
4709 Args:
4710 project: string, A parameter (required)
4711 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
4712 body: object, The request body.
4713 The object takes the form of:
4714
4715 {
4716 &quot;group&quot;: &quot;A String&quot;, # A URI referencing one of the instance groups or network endpoint groups
4717 # listed in the backend service.
4718 }
4719
4720 x__xgafv: string, V1 error format.
4721 Allowed values
4722 1 - v1 error format
4723 2 - v2 error format
4724
4725 Returns:
4726 An object of the form:
4727
4728 {
4729 &quot;annotations&quot;: { # Metadata defined as annotations on the network endpoint group.
4730 &quot;a_key&quot;: &quot;A String&quot;,
4731 },
4732 &quot;healthStatus&quot;: [ # Health state of the backend instances or endpoints in requested instance or
4733 # network endpoint group, determined based on configured health checks.
4734 {
4735 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
4736 &quot;a_key&quot;: &quot;A String&quot;,
4737 },
4738 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
4739 # instance.
4740 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
4741 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
4742 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
4743 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
4744 # rule&#x27;s IP address assigned to this instance. For other types of load
4745 # balancing, the field indicates VM internal ip.
4746 &quot;ipv6Address&quot;: &quot;A String&quot;,
4747 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
4748 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
4749 # health-checked.
4750 &quot;weight&quot;: &quot;A String&quot;,
4751 &quot;weightError&quot;: &quot;A String&quot;,
4752 },
4753 ],
4754 &quot;kind&quot;: &quot;compute#backendServiceGroupHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend
4755 # services.
4756 }</pre>
4757 </div>
4758
4759 <div class="method">
4760 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
4761 <pre>Gets the access control policy for a resource. May be empty if no such
4762 policy or resource exists.
4763
4764 Args:
4765 project: string, Project ID for this request. (required)
4766 resource: string, Name or id of the resource for this request. (required)
4767 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
4768 x__xgafv: string, V1 error format.
4769 Allowed values
4770 1 - v1 error format
4771 2 - v2 error format
4772
4773 Returns:
4774 An object of the form:
4775
4776 { # An Identity and Access Management (IAM) policy, which specifies access
4777 # controls for Google Cloud resources.
4778 #
4779 #
4780 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
4781 # `members`, or principals, to a single `role`. Principals can be user
4782 # accounts, service accounts, Google groups, and domains (such as G Suite). A
4783 # `role` is a named list of permissions; each `role` can be an IAM predefined
4784 # role or a user-created custom role.
4785 #
4786 # For some types of Google Cloud resources, a `binding` can also specify a
4787 # `condition`, which is a logical expression that allows access to a resource
4788 # only if the expression evaluates to `true`. A condition can add constraints
4789 # based on attributes of the request, the resource, or both. To learn which
4790 # resources support conditions in their IAM policies, see the
4791 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4792 #
4793 # **JSON example:**
4794 #
4795 # ```
4796 # {
4797 # &quot;bindings&quot;: [
4798 # {
4799 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
4800 # &quot;members&quot;: [
4801 # &quot;user:[email protected]&quot;,
4802 # &quot;group:[email protected]&quot;,
4803 # &quot;domain:google.com&quot;,
4804 # &quot;serviceAccount:[email protected]&quot;
4805 # ]
4806 # },
4807 # {
4808 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
4809 # &quot;members&quot;: [
4810 # &quot;user:[email protected]&quot;
4811 # ],
4812 # &quot;condition&quot;: {
4813 # &quot;title&quot;: &quot;expirable access&quot;,
4814 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
4815 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
4816 # }
4817 # }
4818 # ],
4819 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
4820 # &quot;version&quot;: 3
4821 # }
4822 # ```
4823 #
4824 # **YAML example:**
4825 #
4826 # ```
4827 # bindings:
4828 # - members:
4829 # - user:[email protected]
4830 # - group:[email protected]
4831 # - domain:google.com
4832 # - serviceAccount:[email protected]
4833 # role: roles/resourcemanager.organizationAdmin
4834 # - members:
4835 # - user:[email protected]
4836 # role: roles/resourcemanager.organizationViewer
4837 # condition:
4838 # title: expirable access
4839 # description: Does not grant access after Sep 2020
4840 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
4841 # etag: BwWWja0YfJA=
4842 # version: 3
4843 # ```
4844 #
4845 # For a description of IAM and its features, see the
4846 # [IAM documentation](https://cloud.google.com/iam/docs/).
4847 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
4848 { # Specifies the audit configuration for a service.
4849 # The configuration determines which permission types are logged, and what
4850 # identities, if any, are exempted from logging.
4851 # An AuditConfig must have one or more AuditLogConfigs.
4852 #
4853 # If there are AuditConfigs for both `allServices` and a specific service,
4854 # the union of the two AuditConfigs is used for that service: the log_types
4855 # specified in each AuditConfig are enabled, and the exempted_members in each
4856 # AuditLogConfig are exempted.
4857 #
4858 # Example Policy with multiple AuditConfigs:
4859 #
4860 # {
4861 # &quot;audit_configs&quot;: [
4862 # {
4863 # &quot;service&quot;: &quot;allServices&quot;,
4864 # &quot;audit_log_configs&quot;: [
4865 # {
4866 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4867 # &quot;exempted_members&quot;: [
4868 # &quot;user:[email protected]&quot;
4869 # ]
4870 # },
4871 # {
4872 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4873 # },
4874 # {
4875 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
4876 # }
4877 # ]
4878 # },
4879 # {
4880 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
4881 # &quot;audit_log_configs&quot;: [
4882 # {
4883 # &quot;log_type&quot;: &quot;DATA_READ&quot;
4884 # },
4885 # {
4886 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
4887 # &quot;exempted_members&quot;: [
4888 # &quot;user:[email protected]&quot;
4889 # ]
4890 # }
4891 # ]
4892 # }
4893 # ]
4894 # }
4895 #
4896 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4897 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4898 # `[email protected]` from DATA_WRITE logging.
4899 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4900 { # Provides the configuration for logging a type of permissions.
4901 # Example:
4902 #
4903 # {
4904 # &quot;audit_log_configs&quot;: [
4905 # {
4906 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4907 # &quot;exempted_members&quot;: [
4908 # &quot;user:[email protected]&quot;
4909 # ]
4910 # },
4911 # {
4912 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4913 # }
4914 # ]
4915 # }
4916 #
4917 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4918 # [email protected] from DATA_READ logging.
4919 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4920 # permission.
4921 # Follows the same format of Binding.members.
4922 &quot;A String&quot;,
4923 ],
4924 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4925 },
4926 ],
4927 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4928 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4929 # `allServices` is a special value that covers all services.
4930 },
4931 ],
4932 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4933 # may specify a `condition` that determines how and when the `bindings` are
4934 # applied. Each of the `bindings` must contain at least one principal.
4935 #
4936 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4937 # of these principals can be Google groups. Each occurrence of a principal
4938 # counts towards these limits. For example, if the `bindings` grant 50
4939 # different roles to `user:[email protected]`, and not to any other
4940 # principal, then you can add another 1,450 principals to the `bindings` in
4941 # the `Policy`.
4942 { # Associates `members`, or principals, with a `role`.
4943 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4944 #
4945 # If the condition evaluates to `true`, then this binding applies to the
4946 # current request.
4947 #
4948 # If the condition evaluates to `false`, then this binding does not apply to
4949 # the current request. However, a different role binding might grant the same
4950 # role to one or more of the principals in this binding.
4951 #
4952 # To learn which resources support conditions in their IAM policies, see the
4953 # [IAM
4954 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4955 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4956 # are documented at https://github.com/google/cel-spec.
4957 #
4958 # Example (Comparison):
4959 #
4960 # title: &quot;Summary size limit&quot;
4961 # description: &quot;Determines if a summary is less than 100 chars&quot;
4962 # expression: &quot;document.summary.size() &lt; 100&quot;
4963 #
4964 # Example (Equality):
4965 #
4966 # title: &quot;Requestor is owner&quot;
4967 # description: &quot;Determines if requestor is the document owner&quot;
4968 # expression: &quot;document.owner == request.auth.claims.email&quot;
4969 #
4970 # Example (Logic):
4971 #
4972 # title: &quot;Public documents&quot;
4973 # description: &quot;Determine whether the document should be publicly visible&quot;
4974 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4975 #
4976 # Example (Data Manipulation):
4977 #
4978 # title: &quot;Notification string&quot;
4979 # description: &quot;Create a notification string with a timestamp.&quot;
4980 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4981 #
4982 # The exact variables and functions that may be referenced within an expression
4983 # are determined by the service that evaluates it. See the service
4984 # documentation for additional information.
4985 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4986 # describes the expression, e.g. when hovered over it in a UI.
4987 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4988 # syntax.
4989 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4990 # reporting, e.g. a file name and a position in the file.
4991 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4992 # its purpose. This can be used e.g. in UIs which allow to enter the
4993 # expression.
4994 },
4995 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4996 # `members` can have the following values:
4997 #
4998 # * `allUsers`: A special identifier that represents anyone who is
4999 # on the internet; with or without a Google account.
5000 #
5001 # * `allAuthenticatedUsers`: A special identifier that represents anyone
5002 # who is authenticated with a Google account or a service account.
5003 # Does not include identities that come from external identity providers
5004 # (IdPs) through identity federation.
5005 #
5006 # * `user:{emailid}`: An email address that represents a specific Google
5007 # account. For example, `[email protected]` .
5008 #
5009 #
5010 # * `serviceAccount:{emailid}`: An email address that represents a Google
5011 # service account. For example,
5012 # `[email protected]`.
5013 #
5014 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
5015 # identifier for a
5016 # [Kubernetes service
5017 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
5018 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
5019 #
5020 # * `group:{emailid}`: An email address that represents a Google group.
5021 # For example, `[email protected]`.
5022 #
5023 #
5024 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
5025 # users of that domain. For example, `google.com` or `example.com`.
5026 #
5027 #
5028 #
5029 #
5030 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5031 # A single identity in a workforce identity pool.
5032 #
5033 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
5034 # All workforce identities in a group.
5035 #
5036 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5037 # All workforce identities with a specific attribute value.
5038 #
5039 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
5040 # All identities in a workforce identity pool.
5041 #
5042 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
5043 # A single identity in a workload identity pool.
5044 #
5045 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
5046 # A workload identity pool group.
5047 #
5048 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5049 # All identities in a workload identity pool with a certain attribute.
5050 #
5051 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
5052 # All identities in a workload identity pool.
5053 #
5054 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
5055 # identifier) representing a user that has been recently deleted. For
5056 # example, `[email protected]?uid=123456789012345678901`. If the user is
5057 # recovered, this value reverts to `user:{emailid}` and the recovered user
5058 # retains the role in the binding.
5059 #
5060 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
5061 # unique identifier) representing a service account that has been recently
5062 # deleted. For example,
5063 # `[email protected]?uid=123456789012345678901`.
5064 # If the service account is undeleted, this value reverts to
5065 # `serviceAccount:{emailid}` and the undeleted service account retains the
5066 # role in the binding.
5067 #
5068 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
5069 # identifier) representing a Google group that has been recently
5070 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
5071 # the group is recovered, this value reverts to `group:{emailid}` and the
5072 # recovered group retains the role in the binding.
5073 #
5074 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5075 # Deleted single identity in a workforce identity pool. For example,
5076 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
5077 &quot;A String&quot;,
5078 ],
5079 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
5080 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
5081 #
5082 # For an overview of the IAM roles and permissions, see the
5083 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
5084 # a list of the available pre-defined roles, see
5085 # [here](https://cloud.google.com/iam/docs/understanding-roles).
5086 },
5087 ],
5088 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
5089 # prevent simultaneous updates of a policy from overwriting each other.
5090 # It is strongly suggested that systems make use of the `etag` in the
5091 # read-modify-write cycle to perform policy updates in order to avoid race
5092 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
5093 # systems are expected to put that etag in the request to `setIamPolicy` to
5094 # ensure that their change will be applied to the same version of the policy.
5095 #
5096 # **Important:** If you use IAM Conditions, you must include the `etag` field
5097 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5098 # you to overwrite a version `3` policy with a version `1` policy, and all of
5099 # the conditions in the version `3` policy are lost.
5100 &quot;version&quot;: 42, # Specifies the format of the policy.
5101 #
5102 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
5103 # are rejected.
5104 #
5105 # Any operation that affects conditional role bindings must specify version
5106 # `3`. This requirement applies to the following operations:
5107 #
5108 # * Getting a policy that includes a conditional role binding
5109 # * Adding a conditional role binding to a policy
5110 # * Changing a conditional role binding in a policy
5111 # * Removing any role binding, with or without a condition, from a policy
5112 # that includes conditions
5113 #
5114 # **Important:** If you use IAM Conditions, you must include the `etag` field
5115 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5116 # you to overwrite a version `3` policy with a version `1` policy, and all of
5117 # the conditions in the version `3` policy are lost.
5118 #
5119 # If a policy does not include any conditions, operations on that policy may
5120 # specify any valid version or leave the field unset.
5121 #
5122 # To learn which resources support conditions in their IAM policies, see the
5123 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5124 }</pre>
5125 </div>
5126
5127 <div class="method">
5128 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
5129 <pre>Creates a BackendService resource in the specified project using
5130 the data included in the request. For more information, see
5131 Backend services overview.
5132
5133 Args:
5134 project: string, Project ID for this request. (required)
5135 body: object, The request body.
5136 The object takes the form of:
5137
5138 { # Represents a Backend Service resource.
5139 #
5140 # A backend service defines how Google Cloud load balancers distribute traffic.
5141 # The backend service configuration contains a set of values, such as the
5142 # protocol used to connect to backends, various distribution and session
5143 # settings, health checks, and timeouts. These settings provide fine-grained
5144 # control over how your load balancer behaves. Most of the settings have
5145 # default values that allow for easy configuration if you need to get started
5146 # quickly.
5147 #
5148 # Backend services in Google Compute Engine can be either regionally or
5149 # globally scoped.
5150 #
5151 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
5152 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
5153 #
5154 # For more information, seeBackend
5155 # Services.
5156 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
5157 # Load Balancers and Traffic Director and requires
5158 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
5159 #
5160 # If set to 0, the cookie is non-persistent and lasts only until
5161 # the end of the browser session (or equivalent). The maximum allowed value
5162 # is two weeks (1,209,600).
5163 #
5164 # Not supported when the backend service is referenced by a URL map that is
5165 # bound to target gRPC proxy that has validateForProxyless field set to true.
5166 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
5167 { # Message containing information of one individual backend.
5168 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
5169 # handle additional traffic or is fully loaded. For usage guidelines, see
5170 # Connection balancing mode.
5171 #
5172 # Backends must use compatible balancing modes. For more information, see
5173 # Supported balancing modes and target capacity settings and
5174 # Restrictions and guidance for instance groups.
5175 #
5176 # Note: Currently, if you use the API to configure incompatible balancing
5177 # modes, the configuration might be accepted even though it has no impact
5178 # and is ignored. Specifically, Backend.maxUtilization is ignored when
5179 # Backend.balancingMode is RATE. In the future, this incompatible combination
5180 # will be rejected.
5181 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
5182 # mode.
5183 # The default value is 1, which means the group serves up to
5184 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
5185 # completely drained, offering 0% of its available capacity. The valid ranges
5186 # are 0.0 and [0.1,1.0].
5187 # You cannot configure a setting larger than 0 and smaller than0.1.
5188 # You cannot configure a setting of 0 when there is only one
5189 # backend attached to the backend service.
5190 #
5191 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
5192 # internet NEGs, regional serverless NEGs, and PSC NEGs.
5193 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
5194 # BalancingMode.
5195 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
5196 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
5197 # Monitoring, but is not used for load balancing.
5198 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
5199 # balancing mode. The valid range is [0.0, 1.0].
5200 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5201 # long and match the regular expression
5202 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5203 # first character must be a lowercase letter, and all following
5204 # characters must be a dash, period, underscore, lowercase letter, or
5205 # digit, except the last character, which cannot be a dash, period, or
5206 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5207 # field can only be used for a global or regional backend service with the
5208 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5209 },
5210 ],
5211 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5212 # create the resource.
5213 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
5214 # failover backend can be configured for a given BackendService.
5215 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
5216 # group or network endpoint
5217 # group (NEG) resource. To determine what types of backends a load
5218 # balancer supports, see the [Backend services
5219 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
5220 #
5221 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
5222 # or NEG. Partial URLs are not supported.
5223 #
5224 # If haPolicy is specified, backends must refer to NEG resources of type
5225 # GCE_VM_IP.
5226 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5227 # guidelines, seeConnection
5228 # balancing mode and Utilization
5229 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
5230 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5231 # guidelines, seeConnection
5232 # balancing mode and Utilization
5233 # balancing mode.
5234 #
5235 # Not available if the backend&#x27;s balancingMode isRATE.
5236 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
5237 # For usage guidelines, seeConnection
5238 # balancing mode and Utilization
5239 # balancing mode.
5240 #
5241 # Not available if the backend&#x27;s balancingMode isRATE.
5242 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
5243 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
5244 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
5245 # Not available if backend&#x27;s balancingMode is RATE
5246 # or CONNECTION.
5247 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
5248 # Not available if backend&#x27;s balancingMode is RATE
5249 # or CONNECTION.
5250 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
5251 # usage guidelines, seeRate
5252 # balancing mode and Utilization
5253 # balancing mode.
5254 #
5255 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5256 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
5257 # guidelines, seeRate
5258 # balancing mode and Utilization
5259 # balancing mode.
5260 #
5261 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5262 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
5263 # guidelines, seeRate
5264 # balancing mode and Utilization
5265 # balancing mode.
5266 #
5267 # Not available if the backend&#x27;s balancingMode isCONNECTION.
5268 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
5269 #
5270 # For usage guidelines, seeUtilization
5271 # balancing mode.
5272 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
5273 # the backend.
5274 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
5275 },
5276 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
5277 # sending traffic to backends with default preference. The possible values
5278 # are:
5279 #
5280 # - PREFERRED: Backends with this preference level will be
5281 # filled up to their capacity limits first, based on RTT.
5282 # - DEFAULT: If preferred backends don&#x27;t have enough
5283 # capacity, backends in this layer would be used and traffic would be
5284 # assigned based on the load balancing algorithm you use. This is the
5285 # default
5286 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
5287 # Attachment).
5288 # e.g.
5289 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
5290 # for Cloud Run service.
5291 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
5292 # for PSC Service Attachment.
5293 &quot;trafficDuration&quot;: &quot;A String&quot;,
5294 },
5295 ],
5296 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
5297 # specified load balancer types.
5298 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
5299 # Pragma or Authorization headers. Up to 5 headers can be specified.
5300 # The cache is bypassed for all cdnPolicy.cacheMode settings.
5301 { # Bypass the cache when the specified request headers are present,
5302 # e.g. Pragma or Authorization headers. Values are case insensitive.
5303 # The presence of such a header overrides the cache_mode setting.
5304 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
5305 # Values are case-insensitive.
5306 },
5307 ],
5308 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
5309 # CDN.
5310 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
5311 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
5312 &quot;A String&quot;,
5313 ],
5314 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
5315 # The name=value pair will be used in the cache key Cloud CDN generates.
5316 &quot;A String&quot;,
5317 ],
5318 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
5319 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
5320 # query_string_whitelist and query_string_blacklist. If neither is set, the
5321 # entire query string will be included. If false, the query string will be
5322 # excluded from the cache key entirely.
5323 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
5324 # parameters will be included. Either specify query_string_whitelist or
5325 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
5326 # not treated as delimiters.
5327 &quot;A String&quot;,
5328 ],
5329 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
5330 # parameters will be excluded. Either specify query_string_whitelist or
5331 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
5332 # not treated as delimiters.
5333 &quot;A String&quot;,
5334 ],
5335 },
5336 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
5337 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
5338 # headers to cache content. Responses without these headers will not be
5339 # cached at Google&#x27;s edge, and will require a full trip to the origin on
5340 # every request, potentially impacting performance and increasing load on
5341 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
5342 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
5343 # Warning: this may result in Cloud CDN caching private,
5344 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
5345 # including common image formats, media (video and audio), and web assets
5346 # (JavaScript and CSS). Requests and responses that are marked as
5347 # uncacheable, as well as dynamic content (including HTML), will not be
5348 # cached.
5349 #
5350 # If no value is provided for cdnPolicy.cacheMode, it defaults
5351 # to CACHE_ALL_STATIC.
5352 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
5353 # used to clamp the max-age (or Expires) value sent to the client. With
5354 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
5355 # response max-age directive, along with a &quot;public&quot; directive. For
5356 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
5357 # from the origin (if specified), or else sets the response max-age
5358 # directive to the lesser of the client_ttl and default_ttl, and also
5359 # ensures a &quot;public&quot; cache-control directive is present.
5360 # If a client TTL is not specified, a default value (1 hour) will be used.
5361 # The maximum allowed value is 31,622,400s (1 year).
5362 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
5363 # responses that do not have an existing valid TTL (max-age or s-maxage).
5364 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5365 # The value of defaultTTL cannot be set to a value greater than that of
5366 # maxTTL, but can be equal.
5367 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
5368 # will overwrite the TTL set in all responses. The maximum allowed value is
5369 # 31,622,400s (1 year), noting that infrequently accessed objects may be
5370 # evicted from the cache before the defined TTL.
5371 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
5372 # origin.
5373 # Cache directives that attempt to set a max-age or s-maxage higher than
5374 # this, or an Expires header more than maxTTL seconds in the future will
5375 # be capped at the value of maxTTL, as if it were the value of an
5376 # s-maxage Cache-Control directive.
5377 # Headers sent to the client will not be modified.
5378 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
5379 # The maximum allowed value is 31,622,400s (1 year), noting that
5380 # infrequently accessed objects may be evicted from the cache before
5381 # the defined TTL.
5382 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
5383 # to apply fine-grained caching for common errors or redirects.
5384 # This can reduce the load on your origin and improve end-user
5385 # experience by reducing response latency.
5386 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
5387 # negative caching applies to responses with the specified response code
5388 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
5389 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
5390 # to all responses with the specified response code, and override any
5391 # caching headers.
5392 # By default, Cloud CDN will apply the following default TTLs to these
5393 # status codes:
5394 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
5395 # HTTP 404 (Not Found), 410 (Gone),
5396 # 451 (Unavailable For Legal Reasons): 120s
5397 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
5398 # These defaults can be overridden in negative_caching_policy.
5399 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
5400 # negative_caching must be enabled to configure negative_caching_policy.
5401 # Omitting the policy and leaving negative_caching enabled will use
5402 # Cloud CDN&#x27;s default cache TTLs.
5403 # Note that when specifying an explicit negative_caching_policy, you
5404 # should take care to specify a cache TTL for all response codes
5405 # that you wish to cache. Cloud CDN will not apply any default
5406 # negative caching when a policy exists.
5407 { # Specify CDN TTLs for response error codes.
5408 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
5409 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
5410 # specified as values, and you cannot specify a status code more than
5411 # once.
5412 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
5413 # corresponding status code.
5414 # The maximum allowed value is 1800s (30 minutes), noting that
5415 # infrequently accessed objects may be evicted from the cache before the
5416 # defined TTL.
5417 },
5418 ],
5419 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
5420 # requests into a small number of requests to the origin.
5421 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
5422 # content with the origin, or when an error is encountered when refreshing
5423 # the cache.
5424 # This setting defines the default &quot;max-stale&quot; duration for any cached
5425 # responses that do not specify a max-stale directive. Stale responses that
5426 # exceed the TTL configured here will not be served. The default limit
5427 # (max-stale) is 86400s (1 day), which will allow stale content to be
5428 # served up to this limit beyond the max-age (or s-maxage) of a cached
5429 # response.
5430 # The maximum allowed value is 604800 (1 week).
5431 # Set this to zero (0) to disable serve-while-stale.
5432 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
5433 # considered fresh. After this time period, the response will be
5434 # revalidated before being served. Defaults to 1hr (3600s). When serving
5435 # responses to signed URL requests, Cloud CDN will internally behave as
5436 # though all responses from this backend had a &quot;Cache-Control:
5437 # public, max-age=[TTL]&quot; header, regardless of any existing
5438 # Cache-Control header. The actual headers served in responses will not be
5439 # altered.
5440 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
5441 &quot;A String&quot;,
5442 ],
5443 },
5444 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
5445 # backend service.
5446 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
5447 # as a count of seconds and fractions of seconds at nanosecond
5448 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5449 # or &quot;month&quot;. Range is approximately 10,000 years.
5450 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5451 # Durations less than one second are represented with a 0
5452 # `seconds` field and a positive `nanos` field. Must be from 0
5453 # to 999,999,999 inclusive.
5454 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5455 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5456 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5457 },
5458 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
5459 # there is no limit.
5460 #
5461 # Not supported when the backend service is referenced by a URL map that is
5462 # bound to target gRPC proxy that has validateForProxyless field set to true.
5463 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
5464 # not specified, there is no limit.
5465 #
5466 # Not supported when the backend service is referenced by a URL map that is
5467 # bound to target gRPC proxy that has validateForProxyless field set to true.
5468 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
5469 # service. If not specified, there is no limit.
5470 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
5471 # This parameter is respected by both the HTTP/1.1 and HTTP/2
5472 # implementations. If not specified, there is no limit. Setting this
5473 # parameter to 1 will effectively disable keep alive.
5474 #
5475 # Not supported when the backend service is referenced by a URL map that is
5476 # bound to target gRPC proxy that has validateForProxyless field set to true.
5477 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
5478 # not specified, the default is 1.
5479 #
5480 # Not supported when the backend service is referenced by a URL map that is
5481 # bound to target gRPC proxy that has validateForProxyless field set to true.
5482 },
5483 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
5484 # the client&#x27;s Accept-Encoding header.
5485 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
5486 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
5487 # instance. For supported load balancers and protocols, as described inEnabling
5488 # connection draining.
5489 },
5490 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
5491 # tracking policy settings are only available for external passthrough
5492 # Network Load Balancers and internal passthrough Network Load Balancers.
5493 #
5494 # connectionTrackingPolicy cannot be specified with haPolicy.
5495 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
5496 # value is DEFAULT_FOR_PROTOCOL.
5497 #
5498 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
5499 # persist on unhealthy backends only for connection-oriented protocols
5500 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
5501 # Affinity is configured for 5-tuple. They do not persist forUDP.
5502 #
5503 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
5504 # the existing connections on the unhealthy backend are never persisted on
5505 # the unhealthy backend. They are always diverted to newly selected healthy
5506 # backends (unless all backends are unhealthy).
5507 #
5508 # If set to ALWAYS_PERSIST, existing connections always
5509 # persist on unhealthy backends regardless of protocol and session
5510 # affinity. It is generally not recommended to use this mode overriding the
5511 # default.
5512 #
5513 # For more details, see [Connection Persistence for Network Load
5514 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
5515 # and [Connection Persistence for Internal TCP/UDP Load
5516 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
5517 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
5518 # Balancers. This option is not available publicly.
5519 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
5520 # matching traffic (in seconds).
5521 #
5522 # For internal passthrough Network Load Balancers:
5523 #
5524 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
5525 # - It can be set only if Connection Tracking is less than 5-tuple
5526 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
5527 # Mode is PER_SESSION).
5528 #
5529 #
5530 #
5531 # For external passthrough Network Load Balancers the default is 60
5532 # seconds. This option is not available publicly.
5533 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
5534 # options:
5535 #
5536 # - PER_CONNECTION: This is the default mode. The Connection
5537 # Tracking is performed as per the Connection Key (default Hash Method) for
5538 # the specific protocol.
5539 # - PER_SESSION: The Connection Tracking is performed as per
5540 # the configured Session Affinity. It matches the configured Session
5541 # Affinity.
5542 #
5543 #
5544 #
5545 # For more details, see [Tracking Mode for Network Load
5546 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
5547 # and [Tracking Mode for Internal TCP/UDP Load
5548 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
5549 },
5550 &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
5551 # affinity based on HTTP headers, cookies or other properties. This load
5552 # balancing policy is applicable only for HTTP connections. The affinity to a
5553 # particular destination host will be lost when one or more hosts are
5554 # added/removed from the destination service. This field specifies parameters
5555 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
5556 #
5557 # This field is applicable to either:
5558 #
5559 # - A regional backend service with the service protocol set to HTTP,
5560 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
5561 # INTERNAL_MANAGED.
5562 # - A global backend service with the
5563 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5564 &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
5565 # be used as the hash key for the consistent hash load balancer. If the
5566 # cookie is not present, it will be generated. This field is applicable if
5567 # the sessionAffinity is set to HTTP_COOKIE.
5568 #
5569 # Not supported when the backend service is referenced by a URL map that is
5570 # bound to target gRPC proxy that has validateForProxyless field set to true.
5571 # for load balancing policies that use a consistent hash.
5572 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
5573 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
5574 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
5575 # as a count of seconds and fractions of seconds at nanosecond
5576 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5577 # or &quot;month&quot;. Range is approximately 10,000 years.
5578 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5579 # Durations less than one second are represented with a 0
5580 # `seconds` field and a positive `nanos` field. Must be from 0
5581 # to 999,999,999 inclusive.
5582 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5583 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5584 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5585 },
5586 },
5587 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
5588 # applicable if the sessionAffinity is set toHEADER_FIELD.
5589 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
5590 # 1024. Larger ring sizes result in more granular load distributions. If the
5591 # number of hosts in the load balancing pool is larger than the ring size,
5592 # each host will be assigned a single virtual node.
5593 },
5594 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
5595 # text format.
5596 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
5597 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
5598 # locality_lb_policy.
5599 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
5600 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5601 # long and match the regular expression
5602 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5603 # first character must be a lowercase letter, and all following
5604 # characters must be a dash, period, underscore, lowercase letter, or
5605 # digit, except the last character, which cannot be a dash, period, or
5606 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5607 # field can only be used for a global or regional backend service with the
5608 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5609 },
5610 ],
5611 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
5612 # custom
5613 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5614 &quot;A String&quot;,
5615 ],
5616 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
5617 # custom
5618 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
5619 &quot;A String&quot;,
5620 ],
5621 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5622 # create the resource.
5623 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
5624 # backend service with dynamic forwarding feature which together with Service
5625 # Extension allows customized and complex routing logic.
5626 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
5627 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
5628 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
5629 },
5630 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
5631 # service. Some ranges are restricted: Restricted
5632 # ranges.
5633 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
5634 },
5635 },
5636 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
5637 # this backend service.
5638 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
5639 # global external Application Load Balancer.
5640 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
5641 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
5642 #
5643 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
5644 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
5645 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
5646 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
5647 # externalManagedMigrationTestingPercentage.
5648 #
5649 # Rolling back a migration requires the states to be set in reverse order. So
5650 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
5651 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
5652 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
5653 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
5654 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
5655 # external Application Load Balancer.
5656 #
5657 # The value of this field must be in the range [0, 100].
5658 #
5659 # Session affinity options will slightly affect this routing behavior, for
5660 # more details, see:Session
5661 # Affinity.
5662 #
5663 # This value can only be set if the loadBalancingScheme in the BackendService
5664 # is set to EXTERNAL (when using the classic Application Load Balancer) and
5665 # the migration state is TEST_BY_PERCENTAGE.
5666 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
5667 # as a backup (failover) backend.
5668 # For load balancers that have configurable failover:
5669 # [Internal passthrough Network Load
5670 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5671 # and [external passthrough Network Load
5672 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5673 #
5674 # failoverPolicy cannot be specified with haPolicy.
5675 # failover:
5676 # [Internal passthrough Network Load
5677 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5678 # and [external passthrough
5679 # Network Load
5680 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5681 # On failover or failback, this field indicates whether connection draining
5682 # will be honored. Google Cloud has a fixed connection draining timeout of
5683 # 10 minutes. A setting of true terminates existing TCP
5684 # connections to the active pool during failover and failback, immediately
5685 # draining traffic. A setting of false allows existing TCP
5686 # connections to persist, even on VMs no longer in the active pool, for up
5687 # to the duration of the connection draining timeout (10 minutes).
5688 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
5689 #
5690 # The default is false.
5691 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
5692 # load balancer are dropped when all primary and all backup backend VMs are
5693 # unhealthy.If set to false, connections are distributed
5694 # among all primary VMs when all primary and all backup backend VMs are
5695 # unhealthy.
5696 # For load balancers that have configurable
5697 # failover:
5698 # [Internal passthrough
5699 # Network Load
5700 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5701 # and [external passthrough
5702 # Network Load
5703 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5704 # The default is false.
5705 &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
5706 # failover when the number of healthy primary VMs equals zero.
5707 # For all other values, the load balancer performs a failover when the
5708 # total number of healthy primary VMs is less than this ratio.
5709 # For load balancers that have configurable
5710 # failover:
5711 # [Internal TCP/UDP Load
5712 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
5713 # and [external TCP/UDP Load
5714 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
5715 },
5716 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
5717 # This field is used in optimistic locking. This field will be ignored when
5718 # inserting a BackendService. An up-to-date fingerprint must be provided in
5719 # order to update the BackendService, otherwise the request will
5720 # fail with error 412 conditionNotMet.
5721 #
5722 # To see the latest fingerprint, make a get() request to
5723 # retrieve a BackendService.
5724 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
5725 # Protocol Forwarding.
5726 #
5727 # The backends of this regional backend service must only specify zonal
5728 # network endpoint groups (NEGs) of type GCE_VM_IP.
5729 #
5730 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
5731 # regional backend service must set the network field. All zonal NEGs must
5732 # belong to the same network. However, individual NEGs can
5733 # belong to different subnetworks of that network.
5734 #
5735 # When haPolicy is specified, the set of attached network endpoints across
5736 # all backends comprise an High Availability domain from which one endpoint
5737 # is selected as the active endpoint (the leader) that receives all
5738 # traffic.
5739 #
5740 # haPolicy can be added only at backend service creation time. Once set up,
5741 # it cannot be deleted.
5742 #
5743 # Note that haPolicy is not for load balancing, and therefore cannot be
5744 # specified with sessionAffinity, connectionTrackingPolicy, and
5745 # failoverPolicy.
5746 #
5747 # haPolicy requires customers to be responsible for tracking backend
5748 # endpoint health and electing a leader among the healthy endpoints.
5749 # Therefore, haPolicy cannot be specified with healthChecks.
5750 #
5751 # haPolicy can only be specified for External Passthrough Network Load
5752 # Balancers and Internal Passthrough Network Load Balancers.
5753 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
5754 # achieve it.
5755 #
5756 # Supported values are:
5757 #
5758 # - DISABLED: Fast IP Move is disabled. You can only use the
5759 # haPolicy.leader API to update the leader.
5760 # - &gt;GARP_RA: Provides a method to very quickly define a new network
5761 # endpoint as the leader. This method is faster than updating the leader
5762 # using the haPolicy.leader API. Fast IP move works as follows: The VM
5763 # hosting the network endpoint that should become the new leader sends
5764 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
5765 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
5766 # temporarily associates the forwarding rule IP address with that VM, and
5767 # both new and in-flight packets are quickly delivered to that VM.
5768 #
5769 #
5770 #
5771 # Note the important properties of the Fast IP Move functionality:
5772 #
5773 # - The GARP/RA-initiated re-routing stays active for approximately 20
5774 # minutes. After triggering fast failover, you must also
5775 # appropriately set the haPolicy.leader.
5776 # - The new leader instance should continue to send GARP/RA packets
5777 # periodically every 10 seconds until at least 10 minutes after updating
5778 # the haPolicy.leader (but stop immediately if it is no longer the leader).
5779 # - After triggering a fast failover, we recommend that you wait at least
5780 # 3 seconds before sending another GARP/RA packet from a different VM
5781 # instance to avoid race conditions.
5782 # - Don&#x27;t send GARP/RA packets from different VM
5783 # instances at the same time. If multiple instances continue to send
5784 # GARP/RA packets, traffic might be routed to different destinations in an
5785 # alternating order. This condition ceases when a single instance
5786 # issues a GARP/RA packet.
5787 # - The GARP/RA request always takes priority over the leader API.
5788 # Using the haPolicy.leader API to change the leader to a different
5789 # instance will have no effect until the GARP/RA request becomes
5790 # inactive.
5791 # - The GARP/RA packets should follow the GARP/RA
5792 # Packet Specifications..
5793 # - When multiple forwarding rules refer to a regional backend service,
5794 # you need only send a GARP or RA packet for a single forwarding rule
5795 # virtual IP. The virtual IPs for all forwarding rules targeting the same
5796 # backend service will also be moved to the sender of the GARP or RA
5797 # packet.
5798 #
5799 #
5800 #
5801 # The following are the Fast IP Move limitations (that is, when fastIPMove
5802 # is not DISABLED):
5803 #
5804 # - Multiple forwarding rules cannot use the same IP address if one of
5805 # them refers to a regional backend service with fastIPMove.
5806 # - The regional backend service must set the network field, and all
5807 # NEGs must belong to that network. However, individual
5808 # NEGs can belong to different subnetworks of that network.
5809 # - The maximum number of network endpoints across all backends of a
5810 # backend service with fastIPMove is 32.
5811 # - The maximum number of backend services with fastIPMove that can have
5812 # the same network endpoint attached to one of its backends is 64.
5813 # - The maximum number of backend services with fastIPMove in a VPC in a
5814 # region is 64.
5815 # - The network endpoints that are attached to a backend of a backend
5816 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
5817 # - Traffic directed to the leader by a static route next hop will not be
5818 # redirected to a new leader by fast failover. Such traffic will only be
5819 # redirected once an haPolicy.leader update has taken effect. Only traffic
5820 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
5821 # fast failover.
5822 #
5823 #
5824 # haPolicy.fastIPMove can be set only at backend service creation time.
5825 # Once set, it cannot be updated.
5826 #
5827 # By default, fastIpMove is set to DISABLED.
5828 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
5829 # this service as the active endpoint (the leader) that receives all
5830 # traffic.
5831 #
5832 # When the leader changes, there is no connection draining to persist
5833 # existing connections on the old leader.
5834 #
5835 # You are responsible for selecting a suitable endpoint as the
5836 # leader. For example, preferring a healthy endpoint over unhealthy ones.
5837 # Note that this service does not track backend endpoint health, and
5838 # selects the configured leader unconditionally.
5839 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
5840 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
5841 # that the leader is attached to.
5842 #
5843 # The leader&#x27;s backendGroup must already be specified as a backend of
5844 # this backend service. Removing a backend that is designated as the
5845 # leader&#x27;s backendGroup is not permitted.
5846 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
5847 # designated as the leader.
5848 #
5849 # This network endpoint cannot be detached from the NEG specified in
5850 # the haPolicy.leader.backendGroup until the leader is updated with
5851 # another network endpoint, or the leader is removed from the haPolicy.
5852 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
5853 # instance must already be attached to the NEG specified in the
5854 # haPolicy.leader.backendGroup.
5855 #
5856 # The name must be 1-63 characters long, and comply with RFC1035.
5857 # Authorization requires the following IAM permission on the
5858 # specified resource instance: compute.instances.use
5859 },
5860 },
5861 },
5862 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
5863 # httpsHealthChecks (legacy) resource for health checking this backend
5864 # service. Not all backend services support legacy health checks. See
5865 # Load balancer guide. Currently, at most one health check can be
5866 # specified for each backend service. Backend services with
5867 # instance group or zonal NEG backends must have a health check unless
5868 # haPolicy is specified. Backend services with internet or serverless NEG
5869 # backends must not have a health check.
5870 #
5871 # healthChecks[] cannot be specified with haPolicy.
5872 &quot;A String&quot;,
5873 ],
5874 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
5875 # Not available for internal passthrough Network Load Balancers and external
5876 # passthrough Network Load Balancers.
5877 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
5878 # incoming requests.
5879 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
5880 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
5881 # For security reasons, this value cannot be retrieved via the API.
5882 # Instead, the SHA-256 hash of the value is returned in the
5883 # oauth2ClientSecretSha256 field.
5884 #
5885 # @InputOnly
5886 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
5887 },
5888 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
5889 # defined by the server.
5890 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
5891 # from the client to the backend for proxyless gRPC).
5892 # The possible values are:
5893 #
5894 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
5895 # backend service (Instance Group, Managed Instance Group, Network Endpoint
5896 # Group), regardless of traffic from the client to the proxy. Only IPv4
5897 # health checks are used to check the health of the backends. This is the
5898 # default setting.
5899 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
5900 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
5901 # address).
5902 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
5903 # backend service (Instance Group, Managed Instance Group, Network Endpoint
5904 # Group), regardless of traffic from the client to the proxy. Only IPv6
5905 # health checks are used to check the health of the backends.
5906 #
5907 #
5908 #
5909 # This field is applicable to either:
5910 #
5911 # - Advanced global external Application Load Balancer (load balancing
5912 # scheme EXTERNAL_MANAGED),
5913 # - Regional external Application Load
5914 # Balancer,
5915 # - Internal proxy Network Load Balancer (load balancing
5916 # scheme INTERNAL_MANAGED),
5917 # - Regional internal Application Load
5918 # Balancer (load balancing scheme INTERNAL_MANAGED),
5919 # - Traffic
5920 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
5921 # INTERNAL_SELF_MANAGED).
5922 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
5923 # for backend services.
5924 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
5925 # created for one type of load balancer cannot be used with another.
5926 # For more information, refer toChoosing
5927 # a load balancer.
5928 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
5929 # preference. When you use localityLbPolicies, you must set at least one
5930 # value for either the localityLbPolicies[].policy or the
5931 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
5932 # value set in the localityLbPolicy field.
5933 #
5934 # For an example of how to use this field, seeDefine
5935 # a list of preferred policies.
5936 #
5937 # Caution: This field and its children are intended for use in a service mesh
5938 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
5939 # that have this configuration.
5940 { # Container for either a built-in LB policy supported by gRPC or Envoy or
5941 # a custom one implemented by the end user.
5942 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
5943 # deployed with the client.
5944 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
5945 # by a locally installed custom policy implementation.
5946 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
5947 #
5948 # The value should match the name of a custom implementation registered
5949 # on the gRPC clients. It should follow protocol buffer message naming
5950 # conventions and include the full path (for example,
5951 # myorg.CustomLbPolicy). The maximum length is 256 characters.
5952 #
5953 # Do not specify the same custom policy more than once for a
5954 # backend. If you do, the configuration is rejected.
5955 #
5956 # For an example of how to use this field, seeUse
5957 # a custom policy.
5958 },
5959 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
5960 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
5961 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
5962 # about these values, see the description of localityLbPolicy.
5963 #
5964 # Do not specify the same policy more than once for a
5965 # backend. If you do, the configuration is rejected.
5966 },
5967 },
5968 ],
5969 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
5970 # possible values are:
5971 #
5972 # - ROUND_ROBIN: This is a simple policy in which each healthy
5973 # backend is selected in round robin order. This is the default.
5974 # - LEAST_REQUEST: An O(1) algorithm which
5975 # selects two random healthy hosts and picks the host which has fewer active
5976 # requests.
5977 # - RING_HASH: The ring/modulo hash load balancer implements
5978 # consistent hashing to backends. The algorithm has the property that the
5979 # addition/removal of a host from a set of N hosts only affects 1/N of the
5980 # requests.
5981 # - RANDOM: The load balancer selects a random healthy
5982 # host.
5983 # - ORIGINAL_DESTINATION: Backend host is selected
5984 # based on the client connection metadata, i.e., connections are opened to
5985 # the same address as the destination address of the incoming connection
5986 # before the connection was redirected to the load balancer.
5987 # - MAGLEV: used as a drop in replacement for the ring hash
5988 # load balancer. Maglev is not as stable as ring hash but has faster table
5989 # lookup build times and host selection times. For more information about
5990 # Maglev, see Maglev:
5991 # A Fast and Reliable Software Network Load Balancer.
5992 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
5993 # Load Balancing using weights computed from Backend reported Custom Metrics.
5994 # If set, the Backend Service responses are expected to contain non-standard
5995 # HTTP response header field Endpoint-Load-Metrics. The reported
5996 # metrics to use for computing the weights are specified via thecustomMetrics field.
5997 #
5998 # This field is applicable to either:
5999 # - A regional backend service with the service protocol set to HTTP,
6000 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6001 # INTERNAL_MANAGED.
6002 # - A global backend service with the
6003 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
6004 # EXTERNAL_MANAGED.
6005 #
6006 #
6007 # If sessionAffinity is not configured—that is, if session
6008 # affinity remains at the default value of NONE—then the
6009 # default value for localityLbPolicy
6010 # is ROUND_ROBIN. If session affinity is set to a value other
6011 # than NONE,
6012 # then the default value for localityLbPolicy isMAGLEV.
6013 #
6014 # Only ROUND_ROBIN and RING_HASH are supported
6015 # when the backend service is referenced by a URL map that is bound to
6016 # target gRPC proxy that has validateForProxyless field set to true.
6017 #
6018 # localityLbPolicy cannot be specified with haPolicy.
6019 &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
6020 # by this backend service. If logging is enabled, logs will be exported to
6021 # Stackdriver.
6022 # backend service.
6023 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
6024 # traffic served by this backend service. The default value is false.
6025 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
6026 { # Determines which HTTP headers will be logged to Stackdriver.
6027 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6028 },
6029 ],
6030 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
6031 { # Determines which HTTP headers will be logged to Stackdriver.
6032 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6033 },
6034 ],
6035 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
6036 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
6037 # of optional fields you want to include in the logs. For example:
6038 # serverInstance, serverGkeDetails.cluster,
6039 # serverGkeDetails.pod.podNamespace
6040 &quot;A String&quot;,
6041 ],
6042 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
6043 # service. Configures whether all, none or a subset of optional fields
6044 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
6045 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
6046 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
6047 # service. The value of the field must be in [0, 1]. This configures the
6048 # sampling rate of requests to the load balancer where 1.0 means all logged
6049 # requests are reported and 0.0 means no logged requests are reported. The
6050 # default value is 1.0.
6051 },
6052 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
6053 # service. Duration is computed from the beginning of the stream until the
6054 # response has been completely processed, including all retries. A stream
6055 # that does not complete in this duration is closed.
6056 #
6057 # If not specified, there will be no timeout limit, i.e. the maximum
6058 # duration is infinite.
6059 #
6060 # This value can be overridden in the PathMatcher configuration of the
6061 # UrlMap that references this backend service.
6062 #
6063 # This field is only allowed when the loadBalancingScheme of
6064 # the backend service is INTERNAL_SELF_MANAGED.
6065 # as a count of seconds and fractions of seconds at nanosecond
6066 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6067 # or &quot;month&quot;. Range is approximately 10,000 years.
6068 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6069 # Durations less than one second are represented with a 0
6070 # `seconds` field and a positive `nanos` field. Must be from 0
6071 # to 999,999,999 inclusive.
6072 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6073 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6074 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6075 },
6076 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
6077 # controller and read by the backend RCTH
6078 &quot;a_key&quot;: &quot;A String&quot;,
6079 },
6080 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6081 # The name must be 1-63 characters long, and comply withRFC1035.
6082 # Specifically, the name must be 1-63 characters long and match the regular
6083 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6084 # character must be a lowercase letter, and all following characters must
6085 # be a dash, lowercase letter, or digit, except the last character, which
6086 # cannot be a dash.
6087 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
6088 #
6089 # This field must be set for Internal Passthrough Network Load Balancers when
6090 # the haPolicy is enabled, and for External Passthrough Network Load
6091 # Balancers when the haPolicy fastIpMove is enabled.
6092 #
6093 # 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.
6094 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
6095 # Load Balancers.
6096 #
6097 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
6098 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
6099 # endpoints in the local zone.
6100 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
6101 # possible values are:
6102 #
6103 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
6104 # is disabled. The load balancer distributes new connections to all
6105 # healthy backend endpoints across all zones.
6106 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
6107 # enabled. The load balancer distributes new connections to all healthy
6108 # backend endpoints in the local zone only. If there are no healthy
6109 # backend endpoints in the local zone, the load balancer distributes
6110 # new connections to all backend endpoints in the local zone.
6111 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
6112 # enabled. The load balancer distributes new connections to all healthy
6113 # backend endpoints in the local zone only. If there aren&#x27;t enough
6114 # healthy backend endpoints in the local zone, the load balancer
6115 # distributes new connections to all healthy backend endpoints across all
6116 # zones.
6117 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
6118 # of healthy backend endpoints in a zone to the count of backend
6119 # endpoints in that same zone is equal to or above this threshold, the
6120 # load balancer distributes new connections to all healthy endpoints in
6121 # the local zone only. When the ratio of the count of healthy backend
6122 # endpoints in a zone to the count of backend endpoints in that same
6123 # zone is below this threshold, the load balancer distributes all new
6124 # connections to all healthy endpoints across all zones.
6125 },
6126 },
6127 &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.
6128 # the backend service.
6129 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
6130 # service.
6131 },
6132 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
6133 # load balancing pool of each individual proxy instance that processes the
6134 # traffic for the given backend service. If not set, this feature is
6135 # considered disabled.
6136 #
6137 # Results of the outlier detection algorithm (ejection of endpoints from the
6138 # load balancing pool and returning them back to the pool) are executed
6139 # independently by each proxy instance of the load balancer. In most cases,
6140 # more than one proxy instance handles the traffic received by a backend
6141 # service. Thus, it is possible that an unhealthy endpoint is detected and
6142 # ejected by only some of the proxies, and while this happens, other proxies
6143 # may continue to send requests to the same unhealthy endpoint until they
6144 # detect and eject the unhealthy endpoint.
6145 #
6146 # Applicable backend endpoints can be:
6147 #
6148 # - VM instances in an Instance Group
6149 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
6150 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
6151 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
6152 # Functions Services
6153 # - Private Service Connect NEGs, that resolve to
6154 # Google-managed regional API endpoints or managed services published using
6155 # Private Service Connect
6156 #
6157 #
6158 #
6159 # Applicable backend service types can be:
6160 #
6161 # - A global backend service with the loadBalancingScheme set to
6162 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
6163 # - A regional backend
6164 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
6165 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
6166 # supported for Serverless NEGs.
6167 #
6168 #
6169 #
6170 # Not supported when the backend service is referenced by a URL map that is
6171 # bound to target gRPC proxy that has validateForProxyless field set to true.
6172 # pool for the backend service.
6173 &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
6174 # or 30s.
6175 #
6176 # After a backend endpoint is returned back to the load balancing pool, it
6177 # can be ejected again in another ejection analysis. Thus, the total ejection
6178 # time is equal to the base ejection time multiplied by the number of times
6179 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
6180 # as a count of seconds and fractions of seconds at nanosecond
6181 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6182 # or &quot;month&quot;. Range is approximately 10,000 years.
6183 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6184 # Durations less than one second are represented with a 0
6185 # `seconds` field and a positive `nanos` field. Must be from 0
6186 # to 999,999,999 inclusive.
6187 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6188 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6189 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6190 },
6191 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
6192 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
6193 # return code qualifies as an error. Defaults to 5.
6194 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
6195 # connection errors that are mapped to one of those status codes) before a
6196 # consecutive gateway failure ejection occurs. Defaults to 3.
6197 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6198 # outlier status is detected through consecutive 5xx. This setting can be
6199 # used to disable ejection or to ramp it up slowly. Defaults to 0.
6200 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6201 # outlier status is detected through consecutive gateway failures. This
6202 # setting can be used to disable ejection or to ramp it up slowly. Defaults
6203 # to 100.
6204 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6205 # outlier status is detected through success rate statistics. This setting
6206 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
6207 #
6208 # Not supported when the backend service uses Serverless NEG.
6209 &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
6210 # ejections and backend endpoints being returned to service. The interval is
6211 # equal to the number of seconds as defined in
6212 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
6213 # in outlierDetection.interval.nanos. Defaults to 1 second.
6214 # as a count of seconds and fractions of seconds at nanosecond
6215 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6216 # or &quot;month&quot;. Range is approximately 10,000 years.
6217 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6218 # Durations less than one second are represented with a 0
6219 # `seconds` field and a positive `nanos` field. Must be from 0
6220 # to 999,999,999 inclusive.
6221 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6222 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6223 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6224 },
6225 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
6226 # backend service that can be ejected if the ejection conditions are met.
6227 # Defaults to 50%.
6228 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
6229 # enough request volume to detect success rate outliers. If the number of
6230 # backend endpoints is fewer than this setting, outlier detection via success
6231 # rate statistics is not performed for any backend endpoint in the load
6232 # balancing pool. Defaults to 5.
6233 #
6234 # Not supported when the backend service uses Serverless NEG.
6235 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
6236 # (as defined by the interval duration above) to include this backend
6237 # endpoint in success rate based outlier detection. If the volume is lower
6238 # than this setting, outlier detection via success rate statistics is not
6239 # performed for that backend endpoint. Defaults to 100.
6240 #
6241 # Not supported when the backend service uses Serverless NEG.
6242 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
6243 # outlier ejection. The ejection threshold is the difference between the mean
6244 # success rate, and the product of this factor and the standard deviation of
6245 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
6246 # is divided by a thousand to get a double. That is, if the desired factor
6247 # is 1.9, the runtime value should be 1900. Defaults to 1900.
6248 #
6249 # Not supported when the backend service uses Serverless NEG.
6250 },
6251 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6252 # as part of resource payload.
6253 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6254 # Tag keys and values have the same definition as resource
6255 # manager tags. The field is allowed for INSERT
6256 # only. The keys/values to set on the resource should be specified in
6257 # either ID { : } or Namespaced format
6258 # { : }.
6259 # For example the following are valid inputs:
6260 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6261 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6262 # Note:
6263 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6264 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6265 &quot;a_key&quot;: &quot;A String&quot;,
6266 },
6267 },
6268 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
6269 # the backend. The default value is 80.
6270 # For internal passthrough Network Load Balancers and external passthrough
6271 # Network Load Balancers, omit port.
6272 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
6273 # communication to the backend VMs in that group. The
6274 # named port must be [defined on each backend instance
6275 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
6276 # This parameter has no meaning if the backends are NEGs. For internal
6277 # passthrough Network Load Balancers and external passthrough Network Load
6278 # Balancers, omit port_name.
6279 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
6280 # with backends.
6281 #
6282 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
6283 # depending on the chosen load balancer or Traffic Director configuration.
6284 # Refer to the documentation for the load balancers or for Traffic Director
6285 # for more information.
6286 #
6287 # Must be set to GRPC when the backend service is referenced by a URL map
6288 # that is bound to target gRPC proxy.
6289 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
6290 # resides. This field is not applicable to global backend services.
6291 # You must specify this field as part of the HTTP request URL. It is
6292 # not settable as a field in the request body.
6293 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
6294 # backend service.
6295 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
6296 # service. This field is applicable to a global backend service with the
6297 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
6298 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
6299 &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
6300 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
6301 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
6302 # private storage buckets that support Signature Version 4 for authentication.
6303 # The service name for generating the authentication header will always default
6304 # to &#x27;s3&#x27;.
6305 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
6306 # creating a backend that uses AWS v4 signature authentication, but will not
6307 # be returned as part of the configuration when queried with a REST API GET
6308 # request.
6309 #
6310 # @InputOnly
6311 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
6312 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
6313 # keep track of different iterations of your access key.
6314 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
6315 # the name of the region your cloud uses to host your origin. For example,
6316 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
6317 },
6318 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
6319 # that describes how clients should authenticate with this service&#x27;s
6320 # backends.
6321 #
6322 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
6323 # to INTERNAL_SELF_MANAGED.
6324 #
6325 # If left blank, communications are not encrypted.
6326 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
6327 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
6328 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
6329 # specified values, the communication continues. Otherwise, it fails. This
6330 # additional check enables the client to verify that the server is authorized
6331 # to run the requested service.
6332 #
6333 # Note that the contents of the server
6334 # certificate&#x27;s subjectAltName field are configured by the
6335 # Public Key Infrastructure which provisions server identities.
6336 #
6337 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
6338 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
6339 # mode).
6340 &quot;A String&quot;,
6341 ],
6342 },
6343 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6344 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
6345 #
6346 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
6347 # If set, lists of backends and health checks must be both empty.
6348 &quot;A String&quot;,
6349 ],
6350 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
6351 #
6352 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
6353 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
6354 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
6355 #
6356 # Only NONE and HEADER_FIELD are supported
6357 # when the backend service is referenced by a URL map that is bound to
6358 # target gRPC proxy that has validateForProxyless field set to true.
6359 #
6360 # For more details, see:
6361 # [Session
6362 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
6363 #
6364 # sessionAffinity cannot be specified with haPolicy.
6365 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
6366 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
6367 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6368 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6369 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6370 # as a count of seconds and fractions of seconds at nanosecond
6371 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6372 # or &quot;month&quot;. Range is approximately 10,000 years.
6373 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6374 # Durations less than one second are represented with a 0
6375 # `seconds` field and a positive `nanos` field. Must be from 0
6376 # to 999,999,999 inclusive.
6377 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6378 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6379 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6380 },
6381 },
6382 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
6383 # Currently this is applicable only for Internal TCP/UDP load balancing,
6384 # Internal HTTP(S) load balancing and Traffic Director.
6385 &quot;policy&quot;: &quot;A String&quot;,
6386 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
6387 # each service mesh client.
6388 #
6389 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
6390 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
6391 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
6392 # `INTERNAL_SELF_MANAGED`.
6393 #
6394 # `subset_size` is optional for Internal HTTP(S) load balancing
6395 # and required for Traffic Director.
6396 #
6397 # If you do not provide this value, Cloud Load Balancing will calculate it
6398 # dynamically to optimize the number of proxies/clients visible to each
6399 # backend and vice versa.
6400 #
6401 # Must be greater than 0. If `subset_size` is larger than the number of
6402 # backends/endpoints, then subsetting is disabled.
6403 },
6404 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
6405 # type of load balancer. For more information see,
6406 # Backend service settings.
6407 # The default is 30 seconds.
6408 # The full range of timeout values allowed goes from 1
6409 # through 2,147,483,647 seconds.
6410 #
6411 # This value can be overridden in the PathMatcher configuration of the
6412 # UrlMap that references this backend service.
6413 #
6414 # Not supported when the backend service is referenced by a URL map that is
6415 # bound to target gRPC proxy that has validateForProxyless field set to true.
6416 # Instead, use maxStreamDuration.
6417 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
6418 # when the backend protocol is SSL, HTTPS or HTTP2.
6419 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
6420 # networksecurity.googleapis.com namespace. Can be used in authenticating
6421 # TLS connections to the backend, as specified by the authenticationMode
6422 # field. Can only be specified if authenticationMode is not NONE.
6423 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
6424 #
6425 #
6426 # Use this property to configure the load balancer back-end to use
6427 # certificates and roots of trust provisioned by the Managed Workload
6428 # Identity system.
6429 #
6430 # The `identity` property is the
6431 # fully-specified SPIFFE ID to use in the SVID presented by the Load
6432 # Balancer Workload.
6433 #
6434 # The SPIFFE ID must be a resource starting with the
6435 # `trustDomain` property value, followed by the path to the Managed
6436 # Workload Identity.
6437 #
6438 # Supported SPIFFE ID format:
6439 #
6440 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
6441 #
6442 #
6443 # The Trust Domain within the Managed Identity must refer to a valid
6444 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
6445 # will be inherited from the Workload Identity Pool.
6446 #
6447 # Restrictions:
6448 #
6449 # - If you set the `identity` property, you cannot manually set
6450 # the following fields:
6451 # - tlsSettings.sni
6452 # - tlsSettings.subjectAltNames
6453 # - tlsSettings.authenticationConfig
6454 #
6455 #
6456 # When defining a `identity` for a RegionBackendServices, the
6457 # corresponding Workload Identity Pool must have a ca_pool
6458 # configured in the same region.
6459 #
6460 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
6461 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
6462 # balancer sends this string as the SNI hostname in the TLS connection to
6463 # the backend, and requires that this string match a Subject Alternative
6464 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
6465 # NEG backend, if the SNI is specified here, the load balancer uses it
6466 # regardless of whether the Regional Internet NEG is specified with FQDN or
6467 # IP address and port. When both sni and subjectAltNames[] are specified,
6468 # the load balancer matches the backend certificate&#x27;s SAN only to
6469 # subjectAltNames[].
6470 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
6471 # verifies during a TLS handshake with the backend. When the server
6472 # presents its X.509 certificate to the Load Balancer, the Load Balancer
6473 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
6474 # match one of the subjectAltNames in the list. This field is limited to 5
6475 # entries. When both sni and subjectAltNames[] are specified, the load
6476 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
6477 { # A Subject Alternative Name that the load balancer matches against the SAN
6478 # field in the TLS certificate provided by the backend, specified as either
6479 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
6480 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
6481 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
6482 },
6483 ],
6484 },
6485 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
6486 {
6487 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
6488 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
6489 # and ForwardingRule.
6490 },
6491 ],
6492 }
6493
6494 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6495 that if you must retry your request, the server will know to ignore the
6496 request if it has already been completed.
6497
6498 For example, consider a situation where you make an initial request and
6499 the request times out. If you make the request again with the same
6500 request ID, the server can check if original operation with the same
6501 request ID was received, and if so, will ignore the second request. This
6502 prevents clients from accidentally creating duplicate commitments.
6503
6504 The request ID must be
6505 a valid UUID with the exception that zero UUID is not supported
6506 (00000000-0000-0000-0000-000000000000).
6507 x__xgafv: string, V1 error format.
6508 Allowed values
6509 1 - v1 error format
6510 2 - v2 error format
6511
6512 Returns:
6513 An object of the form:
6514
6515 { # Represents an Operation resource.
6516 #
6517 # Google Compute Engine has three Operation resources:
6518 #
6519 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
6520 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
6521 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
6522 #
6523 # You can use an operation resource to manage asynchronous API requests.
6524 # For more information, readHandling
6525 # API responses.
6526 #
6527 # Operations can be global, regional or zonal.
6528 #
6529 # - For global operations, use the `globalOperations`
6530 # resource.
6531 # - For regional operations, use the
6532 # `regionOperations` resource.
6533 # - For zonal operations, use
6534 # the `zoneOperations` resource.
6535 #
6536 #
6537 #
6538 # For more information, read
6539 # Global, Regional, and Zonal Resources.
6540 #
6541 # Note that completed Operation resources have a limited
6542 # retention period.
6543 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6544 # Not present otherwise.
6545 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6546 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6547 # set when the operation is created.
6548 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6549 # text format.
6550 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6551 # this field will be populated.
6552 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6553 # operation.
6554 {
6555 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6556 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6557 # details. There is a set of defined message types to use for providing
6558 # details.The syntax depends on the error code. For example,
6559 # QuotaExceededInfo will have details when the error code is
6560 # QUOTA_EXCEEDED.
6561 {
6562 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6563 #
6564 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6565 # is not enabled:
6566 #
6567 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6568 # &quot;domain&quot;: &quot;googleapis.com&quot;
6569 # &quot;metadata&quot;: {
6570 # &quot;resource&quot;: &quot;projects/123&quot;,
6571 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6572 # }
6573 # }
6574 #
6575 # This response indicates that the pubsub.googleapis.com API is not enabled.
6576 #
6577 # Example of an error that is returned when attempting to create a Spanner
6578 # instance in a region that is out of stock:
6579 #
6580 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6581 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6582 # &quot;metadata&quot;: {
6583 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6584 # }
6585 # }
6586 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6587 # is typically the registered service name of the tool or product that
6588 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6589 # generated by some common infrastructure, the error domain must be a
6590 # globally unique value that identifies the infrastructure. For Google API
6591 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6592 &quot;metadatas&quot;: { # Additional structured details about this error.
6593 #
6594 # Keys must match a regular expression of `a-z+` but should
6595 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6596 # length. When identifying the current value of an exceeded limit, the units
6597 # should be contained in the key, not the value. For example, rather than
6598 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6599 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6600 # instances that can be created in a single (batch) request.
6601 &quot;a_key&quot;: &quot;A String&quot;,
6602 },
6603 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6604 # proximate cause of the error. Error reasons are unique within a particular
6605 # domain of errors. This should be at most 63 characters and match a
6606 # regular expression of `A-Z+[A-Z0-9]`, which represents
6607 # UPPER_SNAKE_CASE.
6608 },
6609 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6610 #
6611 # For example, if a quota check failed with an error indicating the calling
6612 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6613 # directly to the right place in the developer console to flip the bit.
6614 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6615 { # Describes a URL link.
6616 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6617 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6618 },
6619 ],
6620 },
6621 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6622 # which can be attached to an RPC error.
6623 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6624 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6625 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6626 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6627 },
6628 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6629 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6630 &quot;a_key&quot;: &quot;A String&quot;,
6631 },
6632 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6633 # type or metric.
6634 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6635 # or metric.
6636 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6637 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6638 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6639 },
6640 },
6641 ],
6642 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6643 # This property is optional.
6644 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6645 },
6646 ],
6647 },
6648 &quot;getVersionOperationMetadata&quot;: {
6649 &quot;inlineSbomInfo&quot;: {
6650 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6651 # appropriate identifiers.
6652 &quot;a_key&quot;: &quot;A String&quot;,
6653 },
6654 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6655 # identifiers.
6656 &quot;a_key&quot;: &quot;A String&quot;,
6657 },
6658 },
6659 },
6660 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6661 # message that was returned, such as `NOT FOUND`.
6662 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6663 # status code that was returned. For example, a `404` means the
6664 # resource was not found.
6665 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6666 # defined by the server.
6667 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6668 # This value is inRFC3339
6669 # text format.
6670 &quot;instancesBulkInsertOperationMetadata&quot;: {
6671 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6672 # Example key: zones/us-central1-a
6673 &quot;a_key&quot;: {
6674 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6675 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6676 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6677 # error.
6678 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6679 # if the flow is rolling forward or rolling back.
6680 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6681 },
6682 },
6683 },
6684 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6685 # Operation resources.
6686 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6687 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6688 # group of operations results from a `bulkInsert` API request.
6689 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6690 # `update`, or `delete`, and so on.
6691 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6692 # There is no requirement that this be linear or support any granularity of
6693 # operations. This should not be used to guess when the operation will be
6694 # complete. This number should monotonically increase as the operation
6695 # progresses.
6696 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6697 # applicable when performing regional operations.
6698 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6699 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6700 # this field will contain information on all underlying zonal actions and
6701 # their state.
6702 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6703 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6704 # Example key: zones/us-central1-a
6705 &quot;a_key&quot;: {
6706 &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
6707 # populated.
6708 # different programming environments, including REST APIs and RPC APIs. It is
6709 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6710 # three pieces of data: error code, error message, and error details.
6711 #
6712 # You can find out more about this error model and how to work with it in the
6713 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6714 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6715 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6716 # message types for APIs to use.
6717 {
6718 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6719 },
6720 ],
6721 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6722 # user-facing error message should be localized and sent in the
6723 # google.rpc.Status.details field, or localized by the client.
6724 },
6725 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6726 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6727 },
6728 },
6729 },
6730 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6731 # This value is inRFC3339
6732 # text format.
6733 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6734 # following:
6735 # `PENDING`, `RUNNING`, or `DONE`.
6736 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6737 # operation.
6738 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6739 # of the target resource.
6740 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6741 # operations related to creating a snapshot, this points to the disk
6742 # that the snapshot was created from.
6743 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6744 # `[email protected]` or
6745 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6746 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6747 # operation, this field will be populated.
6748 {
6749 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6750 # Engine returns NO_RESULTS_ON_PAGE if there
6751 # are no results in the response.
6752 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6753 # value format. For example:
6754 #
6755 # &quot;data&quot;: [
6756 # {
6757 # &quot;key&quot;: &quot;scope&quot;,
6758 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6759 # }
6760 {
6761 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6762 # returned. For example, for warnings where there are no results in a list
6763 # request for a particular zone, this key might be scope and
6764 # the key value might be the zone name. Other examples might be a key
6765 # indicating a deprecated resource and a suggested replacement, or a
6766 # warning about invalid network settings (for example, if an instance
6767 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6768 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6769 },
6770 ],
6771 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6772 },
6773 ],
6774 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6775 # applicable when performing per-zone operations.
6776 }</pre>
6777 </div>
6778
6779 <div class="method">
6780 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
6781 <pre>Retrieves the list of BackendService resources available to the specified
6782 project.
6783
6784 Args:
6785 project: string, Project ID for this request. (required)
6786 filter: string, A filter expression that filters resources listed in the response. Most
6787 Compute resources support two types of filter expressions:
6788 expressions that support regular expressions and expressions that follow
6789 API improvement proposal AIP-160.
6790 These two types of filter expressions cannot be mixed in one request.
6791
6792 If you want to use AIP-160, your expression must specify the field name, an
6793 operator, and the value that you want to use for filtering. The value
6794 must be a string, a number, or a boolean. The operator
6795 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
6796
6797 For example, if you are filtering Compute Engine instances, you can
6798 exclude instances named `example-instance` by specifying
6799 `name != example-instance`.
6800
6801 The `:*` comparison can be used to test whether a key has been defined.
6802 For example, to find all objects with `owner` label use:
6803 ```
6804 labels.owner:*
6805 ```
6806
6807 You can also filter nested fields. For example, you could specify
6808 `scheduling.automaticRestart = false` to include instances only
6809 if they are not scheduled for automatic restarts. You can use filtering
6810 on nested fields to filter based onresource labels.
6811
6812 To filter on multiple expressions, provide each separate expression within
6813 parentheses. For example:
6814 ```
6815 (scheduling.automaticRestart = true)
6816 (cpuPlatform = &quot;Intel Skylake&quot;)
6817 ```
6818 By default, each expression is an `AND` expression. However, you
6819 can include `AND` and `OR` expressions explicitly.
6820 For example:
6821 ```
6822 (cpuPlatform = &quot;Intel Skylake&quot;) OR
6823 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
6824 (scheduling.automaticRestart = true)
6825 ```
6826
6827 If you want to use a regular expression, use the `eq` (equal) or `ne`
6828 (not equal) operator against a single un-parenthesized expression with or
6829 without quotes or against multiple parenthesized expressions. Examples:
6830
6831 `fieldname eq unquoted literal`
6832 `fieldname eq &#x27;single quoted literal&#x27;`
6833 `fieldname eq &quot;double quoted literal&quot;`
6834 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
6835
6836 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
6837 The literal value must match the entire field.
6838
6839 For example, to filter for instances that do not end with name &quot;instance&quot;,
6840 you would use `name ne .*instance`.
6841
6842 You cannot combine constraints on multiple fields using regular
6843 expressions.
6844 maxResults: integer, The maximum number of results per page that should be returned.
6845 If the number of available results is larger than `maxResults`,
6846 Compute Engine returns a `nextPageToken` that can be used to get
6847 the next page of results in subsequent list requests. Acceptable values are
6848 `0` to `500`, inclusive. (Default: `500`)
6849 orderBy: string, Sorts list results by a certain order. By default, results
6850 are returned in alphanumerical order based on the resource name.
6851
6852 You can also sort results in descending order based on the creation
6853 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
6854 results based on the `creationTimestamp` field in
6855 reverse chronological order (newest result first). Use this to sort
6856 resources like operations so that the newest operation is returned first.
6857
6858 Currently, only sorting by `name` or
6859 `creationTimestamp desc` is supported.
6860 pageToken: string, Specifies a page token to use. Set `pageToken` to the
6861 `nextPageToken` returned by a previous list request to get
6862 the next page of results.
6863 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
6864 of failure. The default value is false.
6865
6866 For example, when partial success behavior is enabled, aggregatedList for a
6867 single zone scope either returns all resources in the zone or no resources,
6868 with an error code.
6869 x__xgafv: string, V1 error format.
6870 Allowed values
6871 1 - v1 error format
6872 2 - v2 error format
6873
6874 Returns:
6875 An object of the form:
6876
6877 { # Contains a list of BackendService resources.
6878 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
6879 &quot;items&quot;: [ # A list of BackendService resources.
6880 { # Represents a Backend Service resource.
6881 #
6882 # A backend service defines how Google Cloud load balancers distribute traffic.
6883 # The backend service configuration contains a set of values, such as the
6884 # protocol used to connect to backends, various distribution and session
6885 # settings, health checks, and timeouts. These settings provide fine-grained
6886 # control over how your load balancer behaves. Most of the settings have
6887 # default values that allow for easy configuration if you need to get started
6888 # quickly.
6889 #
6890 # Backend services in Google Compute Engine can be either regionally or
6891 # globally scoped.
6892 #
6893 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
6894 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
6895 #
6896 # For more information, seeBackend
6897 # Services.
6898 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
6899 # Load Balancers and Traffic Director and requires
6900 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
6901 #
6902 # If set to 0, the cookie is non-persistent and lasts only until
6903 # the end of the browser session (or equivalent). The maximum allowed value
6904 # is two weeks (1,209,600).
6905 #
6906 # Not supported when the backend service is referenced by a URL map that is
6907 # bound to target gRPC proxy that has validateForProxyless field set to true.
6908 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
6909 { # Message containing information of one individual backend.
6910 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
6911 # handle additional traffic or is fully loaded. For usage guidelines, see
6912 # Connection balancing mode.
6913 #
6914 # Backends must use compatible balancing modes. For more information, see
6915 # Supported balancing modes and target capacity settings and
6916 # Restrictions and guidance for instance groups.
6917 #
6918 # Note: Currently, if you use the API to configure incompatible balancing
6919 # modes, the configuration might be accepted even though it has no impact
6920 # and is ignored. Specifically, Backend.maxUtilization is ignored when
6921 # Backend.balancingMode is RATE. In the future, this incompatible combination
6922 # will be rejected.
6923 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
6924 # mode.
6925 # The default value is 1, which means the group serves up to
6926 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
6927 # completely drained, offering 0% of its available capacity. The valid ranges
6928 # are 0.0 and [0.1,1.0].
6929 # You cannot configure a setting larger than 0 and smaller than0.1.
6930 # You cannot configure a setting of 0 when there is only one
6931 # backend attached to the backend service.
6932 #
6933 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
6934 # internet NEGs, regional serverless NEGs, and PSC NEGs.
6935 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
6936 # BalancingMode.
6937 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
6938 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
6939 # Monitoring, but is not used for load balancing.
6940 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
6941 # balancing mode. The valid range is [0.0, 1.0].
6942 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6943 # long and match the regular expression
6944 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6945 # first character must be a lowercase letter, and all following
6946 # characters must be a dash, period, underscore, lowercase letter, or
6947 # digit, except the last character, which cannot be a dash, period, or
6948 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6949 # field can only be used for a global or regional backend service with the
6950 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6951 },
6952 ],
6953 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6954 # create the resource.
6955 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
6956 # failover backend can be configured for a given BackendService.
6957 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
6958 # group or network endpoint
6959 # group (NEG) resource. To determine what types of backends a load
6960 # balancer supports, see the [Backend services
6961 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
6962 #
6963 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
6964 # or NEG. Partial URLs are not supported.
6965 #
6966 # If haPolicy is specified, backends must refer to NEG resources of type
6967 # GCE_VM_IP.
6968 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6969 # guidelines, seeConnection
6970 # balancing mode and Utilization
6971 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
6972 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
6973 # guidelines, seeConnection
6974 # balancing mode and Utilization
6975 # balancing mode.
6976 #
6977 # Not available if the backend&#x27;s balancingMode isRATE.
6978 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
6979 # For usage guidelines, seeConnection
6980 # balancing mode and Utilization
6981 # balancing mode.
6982 #
6983 # Not available if the backend&#x27;s balancingMode isRATE.
6984 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
6985 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
6986 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
6987 # Not available if backend&#x27;s balancingMode is RATE
6988 # or CONNECTION.
6989 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
6990 # Not available if backend&#x27;s balancingMode is RATE
6991 # or CONNECTION.
6992 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
6993 # usage guidelines, seeRate
6994 # balancing mode and Utilization
6995 # balancing mode.
6996 #
6997 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6998 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6999 # guidelines, seeRate
7000 # balancing mode and Utilization
7001 # balancing mode.
7002 #
7003 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7004 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
7005 # guidelines, seeRate
7006 # balancing mode and Utilization
7007 # balancing mode.
7008 #
7009 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7010 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
7011 #
7012 # For usage guidelines, seeUtilization
7013 # balancing mode.
7014 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
7015 # the backend.
7016 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
7017 },
7018 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
7019 # sending traffic to backends with default preference. The possible values
7020 # are:
7021 #
7022 # - PREFERRED: Backends with this preference level will be
7023 # filled up to their capacity limits first, based on RTT.
7024 # - DEFAULT: If preferred backends don&#x27;t have enough
7025 # capacity, backends in this layer would be used and traffic would be
7026 # assigned based on the load balancing algorithm you use. This is the
7027 # default
7028 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
7029 # Attachment).
7030 # e.g.
7031 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
7032 # for Cloud Run service.
7033 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
7034 # for PSC Service Attachment.
7035 &quot;trafficDuration&quot;: &quot;A String&quot;,
7036 },
7037 ],
7038 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
7039 # specified load balancer types.
7040 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
7041 # Pragma or Authorization headers. Up to 5 headers can be specified.
7042 # The cache is bypassed for all cdnPolicy.cacheMode settings.
7043 { # Bypass the cache when the specified request headers are present,
7044 # e.g. Pragma or Authorization headers. Values are case insensitive.
7045 # The presence of such a header overrides the cache_mode setting.
7046 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
7047 # Values are case-insensitive.
7048 },
7049 ],
7050 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
7051 # CDN.
7052 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
7053 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
7054 &quot;A String&quot;,
7055 ],
7056 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
7057 # The name=value pair will be used in the cache key Cloud CDN generates.
7058 &quot;A String&quot;,
7059 ],
7060 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
7061 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
7062 # query_string_whitelist and query_string_blacklist. If neither is set, the
7063 # entire query string will be included. If false, the query string will be
7064 # excluded from the cache key entirely.
7065 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
7066 # parameters will be included. Either specify query_string_whitelist or
7067 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
7068 # not treated as delimiters.
7069 &quot;A String&quot;,
7070 ],
7071 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
7072 # parameters will be excluded. Either specify query_string_whitelist or
7073 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
7074 # not treated as delimiters.
7075 &quot;A String&quot;,
7076 ],
7077 },
7078 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
7079 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
7080 # headers to cache content. Responses without these headers will not be
7081 # cached at Google&#x27;s edge, and will require a full trip to the origin on
7082 # every request, potentially impacting performance and increasing load on
7083 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
7084 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
7085 # Warning: this may result in Cloud CDN caching private,
7086 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
7087 # including common image formats, media (video and audio), and web assets
7088 # (JavaScript and CSS). Requests and responses that are marked as
7089 # uncacheable, as well as dynamic content (including HTML), will not be
7090 # cached.
7091 #
7092 # If no value is provided for cdnPolicy.cacheMode, it defaults
7093 # to CACHE_ALL_STATIC.
7094 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
7095 # used to clamp the max-age (or Expires) value sent to the client. With
7096 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
7097 # response max-age directive, along with a &quot;public&quot; directive. For
7098 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
7099 # from the origin (if specified), or else sets the response max-age
7100 # directive to the lesser of the client_ttl and default_ttl, and also
7101 # ensures a &quot;public&quot; cache-control directive is present.
7102 # If a client TTL is not specified, a default value (1 hour) will be used.
7103 # The maximum allowed value is 31,622,400s (1 year).
7104 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
7105 # responses that do not have an existing valid TTL (max-age or s-maxage).
7106 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
7107 # The value of defaultTTL cannot be set to a value greater than that of
7108 # maxTTL, but can be equal.
7109 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
7110 # will overwrite the TTL set in all responses. The maximum allowed value is
7111 # 31,622,400s (1 year), noting that infrequently accessed objects may be
7112 # evicted from the cache before the defined TTL.
7113 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
7114 # origin.
7115 # Cache directives that attempt to set a max-age or s-maxage higher than
7116 # this, or an Expires header more than maxTTL seconds in the future will
7117 # be capped at the value of maxTTL, as if it were the value of an
7118 # s-maxage Cache-Control directive.
7119 # Headers sent to the client will not be modified.
7120 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
7121 # The maximum allowed value is 31,622,400s (1 year), noting that
7122 # infrequently accessed objects may be evicted from the cache before
7123 # the defined TTL.
7124 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
7125 # to apply fine-grained caching for common errors or redirects.
7126 # This can reduce the load on your origin and improve end-user
7127 # experience by reducing response latency.
7128 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
7129 # negative caching applies to responses with the specified response code
7130 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
7131 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
7132 # to all responses with the specified response code, and override any
7133 # caching headers.
7134 # By default, Cloud CDN will apply the following default TTLs to these
7135 # status codes:
7136 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
7137 # HTTP 404 (Not Found), 410 (Gone),
7138 # 451 (Unavailable For Legal Reasons): 120s
7139 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
7140 # These defaults can be overridden in negative_caching_policy.
7141 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
7142 # negative_caching must be enabled to configure negative_caching_policy.
7143 # Omitting the policy and leaving negative_caching enabled will use
7144 # Cloud CDN&#x27;s default cache TTLs.
7145 # Note that when specifying an explicit negative_caching_policy, you
7146 # should take care to specify a cache TTL for all response codes
7147 # that you wish to cache. Cloud CDN will not apply any default
7148 # negative caching when a policy exists.
7149 { # Specify CDN TTLs for response error codes.
7150 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
7151 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
7152 # specified as values, and you cannot specify a status code more than
7153 # once.
7154 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
7155 # corresponding status code.
7156 # The maximum allowed value is 1800s (30 minutes), noting that
7157 # infrequently accessed objects may be evicted from the cache before the
7158 # defined TTL.
7159 },
7160 ],
7161 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
7162 # requests into a small number of requests to the origin.
7163 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
7164 # content with the origin, or when an error is encountered when refreshing
7165 # the cache.
7166 # This setting defines the default &quot;max-stale&quot; duration for any cached
7167 # responses that do not specify a max-stale directive. Stale responses that
7168 # exceed the TTL configured here will not be served. The default limit
7169 # (max-stale) is 86400s (1 day), which will allow stale content to be
7170 # served up to this limit beyond the max-age (or s-maxage) of a cached
7171 # response.
7172 # The maximum allowed value is 604800 (1 week).
7173 # Set this to zero (0) to disable serve-while-stale.
7174 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
7175 # considered fresh. After this time period, the response will be
7176 # revalidated before being served. Defaults to 1hr (3600s). When serving
7177 # responses to signed URL requests, Cloud CDN will internally behave as
7178 # though all responses from this backend had a &quot;Cache-Control:
7179 # public, max-age=[TTL]&quot; header, regardless of any existing
7180 # Cache-Control header. The actual headers served in responses will not be
7181 # altered.
7182 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
7183 &quot;A String&quot;,
7184 ],
7185 },
7186 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
7187 # backend service.
7188 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
7189 # as a count of seconds and fractions of seconds at nanosecond
7190 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7191 # or &quot;month&quot;. Range is approximately 10,000 years.
7192 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7193 # Durations less than one second are represented with a 0
7194 # `seconds` field and a positive `nanos` field. Must be from 0
7195 # to 999,999,999 inclusive.
7196 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7197 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7198 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7199 },
7200 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
7201 # there is no limit.
7202 #
7203 # Not supported when the backend service is referenced by a URL map that is
7204 # bound to target gRPC proxy that has validateForProxyless field set to true.
7205 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
7206 # not specified, there is no limit.
7207 #
7208 # Not supported when the backend service is referenced by a URL map that is
7209 # bound to target gRPC proxy that has validateForProxyless field set to true.
7210 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
7211 # service. If not specified, there is no limit.
7212 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
7213 # This parameter is respected by both the HTTP/1.1 and HTTP/2
7214 # implementations. If not specified, there is no limit. Setting this
7215 # parameter to 1 will effectively disable keep alive.
7216 #
7217 # Not supported when the backend service is referenced by a URL map that is
7218 # bound to target gRPC proxy that has validateForProxyless field set to true.
7219 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
7220 # not specified, the default is 1.
7221 #
7222 # Not supported when the backend service is referenced by a URL map that is
7223 # bound to target gRPC proxy that has validateForProxyless field set to true.
7224 },
7225 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
7226 # the client&#x27;s Accept-Encoding header.
7227 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
7228 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
7229 # instance. For supported load balancers and protocols, as described inEnabling
7230 # connection draining.
7231 },
7232 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
7233 # tracking policy settings are only available for external passthrough
7234 # Network Load Balancers and internal passthrough Network Load Balancers.
7235 #
7236 # connectionTrackingPolicy cannot be specified with haPolicy.
7237 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
7238 # value is DEFAULT_FOR_PROTOCOL.
7239 #
7240 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
7241 # persist on unhealthy backends only for connection-oriented protocols
7242 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
7243 # Affinity is configured for 5-tuple. They do not persist forUDP.
7244 #
7245 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
7246 # the existing connections on the unhealthy backend are never persisted on
7247 # the unhealthy backend. They are always diverted to newly selected healthy
7248 # backends (unless all backends are unhealthy).
7249 #
7250 # If set to ALWAYS_PERSIST, existing connections always
7251 # persist on unhealthy backends regardless of protocol and session
7252 # affinity. It is generally not recommended to use this mode overriding the
7253 # default.
7254 #
7255 # For more details, see [Connection Persistence for Network Load
7256 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
7257 # and [Connection Persistence for Internal TCP/UDP Load
7258 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
7259 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
7260 # Balancers. This option is not available publicly.
7261 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
7262 # matching traffic (in seconds).
7263 #
7264 # For internal passthrough Network Load Balancers:
7265 #
7266 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
7267 # - It can be set only if Connection Tracking is less than 5-tuple
7268 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
7269 # Mode is PER_SESSION).
7270 #
7271 #
7272 #
7273 # For external passthrough Network Load Balancers the default is 60
7274 # seconds. This option is not available publicly.
7275 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
7276 # options:
7277 #
7278 # - PER_CONNECTION: This is the default mode. The Connection
7279 # Tracking is performed as per the Connection Key (default Hash Method) for
7280 # the specific protocol.
7281 # - PER_SESSION: The Connection Tracking is performed as per
7282 # the configured Session Affinity. It matches the configured Session
7283 # Affinity.
7284 #
7285 #
7286 #
7287 # For more details, see [Tracking Mode for Network Load
7288 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
7289 # and [Tracking Mode for Internal TCP/UDP Load
7290 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
7291 },
7292 &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
7293 # affinity based on HTTP headers, cookies or other properties. This load
7294 # balancing policy is applicable only for HTTP connections. The affinity to a
7295 # particular destination host will be lost when one or more hosts are
7296 # added/removed from the destination service. This field specifies parameters
7297 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
7298 #
7299 # This field is applicable to either:
7300 #
7301 # - A regional backend service with the service protocol set to HTTP,
7302 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7303 # INTERNAL_MANAGED.
7304 # - A global backend service with the
7305 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7306 &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
7307 # be used as the hash key for the consistent hash load balancer. If the
7308 # cookie is not present, it will be generated. This field is applicable if
7309 # the sessionAffinity is set to HTTP_COOKIE.
7310 #
7311 # Not supported when the backend service is referenced by a URL map that is
7312 # bound to target gRPC proxy that has validateForProxyless field set to true.
7313 # for load balancing policies that use a consistent hash.
7314 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7315 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7316 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7317 # as a count of seconds and fractions of seconds at nanosecond
7318 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7319 # or &quot;month&quot;. Range is approximately 10,000 years.
7320 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7321 # Durations less than one second are represented with a 0
7322 # `seconds` field and a positive `nanos` field. Must be from 0
7323 # to 999,999,999 inclusive.
7324 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7325 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7326 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7327 },
7328 },
7329 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
7330 # applicable if the sessionAffinity is set toHEADER_FIELD.
7331 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
7332 # 1024. Larger ring sizes result in more granular load distributions. If the
7333 # number of hosts in the load balancing pool is larger than the ring size,
7334 # each host will be assigned a single virtual node.
7335 },
7336 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7337 # text format.
7338 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
7339 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
7340 # locality_lb_policy.
7341 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
7342 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
7343 # long and match the regular expression
7344 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
7345 # first character must be a lowercase letter, and all following
7346 # characters must be a dash, period, underscore, lowercase letter, or
7347 # digit, except the last character, which cannot be a dash, period, or
7348 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
7349 # field can only be used for a global or regional backend service with the
7350 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
7351 },
7352 ],
7353 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
7354 # custom
7355 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7356 &quot;A String&quot;,
7357 ],
7358 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
7359 # custom
7360 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7361 &quot;A String&quot;,
7362 ],
7363 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7364 # create the resource.
7365 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
7366 # backend service with dynamic forwarding feature which together with Service
7367 # Extension allows customized and complex routing logic.
7368 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
7369 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
7370 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
7371 },
7372 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
7373 # service. Some ranges are restricted: Restricted
7374 # ranges.
7375 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
7376 },
7377 },
7378 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
7379 # this backend service.
7380 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
7381 # global external Application Load Balancer.
7382 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
7383 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
7384 #
7385 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
7386 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
7387 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
7388 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
7389 # externalManagedMigrationTestingPercentage.
7390 #
7391 # Rolling back a migration requires the states to be set in reverse order. So
7392 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
7393 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
7394 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
7395 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
7396 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
7397 # external Application Load Balancer.
7398 #
7399 # The value of this field must be in the range [0, 100].
7400 #
7401 # Session affinity options will slightly affect this routing behavior, for
7402 # more details, see:Session
7403 # Affinity.
7404 #
7405 # This value can only be set if the loadBalancingScheme in the BackendService
7406 # is set to EXTERNAL (when using the classic Application Load Balancer) and
7407 # the migration state is TEST_BY_PERCENTAGE.
7408 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
7409 # as a backup (failover) backend.
7410 # For load balancers that have configurable failover:
7411 # [Internal passthrough Network Load
7412 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7413 # and [external passthrough Network Load
7414 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7415 #
7416 # failoverPolicy cannot be specified with haPolicy.
7417 # failover:
7418 # [Internal passthrough Network Load
7419 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7420 # and [external passthrough
7421 # Network Load
7422 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7423 # On failover or failback, this field indicates whether connection draining
7424 # will be honored. Google Cloud has a fixed connection draining timeout of
7425 # 10 minutes. A setting of true terminates existing TCP
7426 # connections to the active pool during failover and failback, immediately
7427 # draining traffic. A setting of false allows existing TCP
7428 # connections to persist, even on VMs no longer in the active pool, for up
7429 # to the duration of the connection draining timeout (10 minutes).
7430 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
7431 #
7432 # The default is false.
7433 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
7434 # load balancer are dropped when all primary and all backup backend VMs are
7435 # unhealthy.If set to false, connections are distributed
7436 # among all primary VMs when all primary and all backup backend VMs are
7437 # unhealthy.
7438 # For load balancers that have configurable
7439 # failover:
7440 # [Internal passthrough
7441 # Network Load
7442 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7443 # and [external passthrough
7444 # Network Load
7445 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7446 # The default is false.
7447 &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
7448 # failover when the number of healthy primary VMs equals zero.
7449 # For all other values, the load balancer performs a failover when the
7450 # total number of healthy primary VMs is less than this ratio.
7451 # For load balancers that have configurable
7452 # failover:
7453 # [Internal TCP/UDP Load
7454 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7455 # and [external TCP/UDP Load
7456 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7457 },
7458 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
7459 # This field is used in optimistic locking. This field will be ignored when
7460 # inserting a BackendService. An up-to-date fingerprint must be provided in
7461 # order to update the BackendService, otherwise the request will
7462 # fail with error 412 conditionNotMet.
7463 #
7464 # To see the latest fingerprint, make a get() request to
7465 # retrieve a BackendService.
7466 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
7467 # Protocol Forwarding.
7468 #
7469 # The backends of this regional backend service must only specify zonal
7470 # network endpoint groups (NEGs) of type GCE_VM_IP.
7471 #
7472 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
7473 # regional backend service must set the network field. All zonal NEGs must
7474 # belong to the same network. However, individual NEGs can
7475 # belong to different subnetworks of that network.
7476 #
7477 # When haPolicy is specified, the set of attached network endpoints across
7478 # all backends comprise an High Availability domain from which one endpoint
7479 # is selected as the active endpoint (the leader) that receives all
7480 # traffic.
7481 #
7482 # haPolicy can be added only at backend service creation time. Once set up,
7483 # it cannot be deleted.
7484 #
7485 # Note that haPolicy is not for load balancing, and therefore cannot be
7486 # specified with sessionAffinity, connectionTrackingPolicy, and
7487 # failoverPolicy.
7488 #
7489 # haPolicy requires customers to be responsible for tracking backend
7490 # endpoint health and electing a leader among the healthy endpoints.
7491 # Therefore, haPolicy cannot be specified with healthChecks.
7492 #
7493 # haPolicy can only be specified for External Passthrough Network Load
7494 # Balancers and Internal Passthrough Network Load Balancers.
7495 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
7496 # achieve it.
7497 #
7498 # Supported values are:
7499 #
7500 # - DISABLED: Fast IP Move is disabled. You can only use the
7501 # haPolicy.leader API to update the leader.
7502 # - &gt;GARP_RA: Provides a method to very quickly define a new network
7503 # endpoint as the leader. This method is faster than updating the leader
7504 # using the haPolicy.leader API. Fast IP move works as follows: The VM
7505 # hosting the network endpoint that should become the new leader sends
7506 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
7507 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
7508 # temporarily associates the forwarding rule IP address with that VM, and
7509 # both new and in-flight packets are quickly delivered to that VM.
7510 #
7511 #
7512 #
7513 # Note the important properties of the Fast IP Move functionality:
7514 #
7515 # - The GARP/RA-initiated re-routing stays active for approximately 20
7516 # minutes. After triggering fast failover, you must also
7517 # appropriately set the haPolicy.leader.
7518 # - The new leader instance should continue to send GARP/RA packets
7519 # periodically every 10 seconds until at least 10 minutes after updating
7520 # the haPolicy.leader (but stop immediately if it is no longer the leader).
7521 # - After triggering a fast failover, we recommend that you wait at least
7522 # 3 seconds before sending another GARP/RA packet from a different VM
7523 # instance to avoid race conditions.
7524 # - Don&#x27;t send GARP/RA packets from different VM
7525 # instances at the same time. If multiple instances continue to send
7526 # GARP/RA packets, traffic might be routed to different destinations in an
7527 # alternating order. This condition ceases when a single instance
7528 # issues a GARP/RA packet.
7529 # - The GARP/RA request always takes priority over the leader API.
7530 # Using the haPolicy.leader API to change the leader to a different
7531 # instance will have no effect until the GARP/RA request becomes
7532 # inactive.
7533 # - The GARP/RA packets should follow the GARP/RA
7534 # Packet Specifications..
7535 # - When multiple forwarding rules refer to a regional backend service,
7536 # you need only send a GARP or RA packet for a single forwarding rule
7537 # virtual IP. The virtual IPs for all forwarding rules targeting the same
7538 # backend service will also be moved to the sender of the GARP or RA
7539 # packet.
7540 #
7541 #
7542 #
7543 # The following are the Fast IP Move limitations (that is, when fastIPMove
7544 # is not DISABLED):
7545 #
7546 # - Multiple forwarding rules cannot use the same IP address if one of
7547 # them refers to a regional backend service with fastIPMove.
7548 # - The regional backend service must set the network field, and all
7549 # NEGs must belong to that network. However, individual
7550 # NEGs can belong to different subnetworks of that network.
7551 # - The maximum number of network endpoints across all backends of a
7552 # backend service with fastIPMove is 32.
7553 # - The maximum number of backend services with fastIPMove that can have
7554 # the same network endpoint attached to one of its backends is 64.
7555 # - The maximum number of backend services with fastIPMove in a VPC in a
7556 # region is 64.
7557 # - The network endpoints that are attached to a backend of a backend
7558 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
7559 # - Traffic directed to the leader by a static route next hop will not be
7560 # redirected to a new leader by fast failover. Such traffic will only be
7561 # redirected once an haPolicy.leader update has taken effect. Only traffic
7562 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
7563 # fast failover.
7564 #
7565 #
7566 # haPolicy.fastIPMove can be set only at backend service creation time.
7567 # Once set, it cannot be updated.
7568 #
7569 # By default, fastIpMove is set to DISABLED.
7570 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
7571 # this service as the active endpoint (the leader) that receives all
7572 # traffic.
7573 #
7574 # When the leader changes, there is no connection draining to persist
7575 # existing connections on the old leader.
7576 #
7577 # You are responsible for selecting a suitable endpoint as the
7578 # leader. For example, preferring a healthy endpoint over unhealthy ones.
7579 # Note that this service does not track backend endpoint health, and
7580 # selects the configured leader unconditionally.
7581 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
7582 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
7583 # that the leader is attached to.
7584 #
7585 # The leader&#x27;s backendGroup must already be specified as a backend of
7586 # this backend service. Removing a backend that is designated as the
7587 # leader&#x27;s backendGroup is not permitted.
7588 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
7589 # designated as the leader.
7590 #
7591 # This network endpoint cannot be detached from the NEG specified in
7592 # the haPolicy.leader.backendGroup until the leader is updated with
7593 # another network endpoint, or the leader is removed from the haPolicy.
7594 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
7595 # instance must already be attached to the NEG specified in the
7596 # haPolicy.leader.backendGroup.
7597 #
7598 # The name must be 1-63 characters long, and comply with RFC1035.
7599 # Authorization requires the following IAM permission on the
7600 # specified resource instance: compute.instances.use
7601 },
7602 },
7603 },
7604 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
7605 # httpsHealthChecks (legacy) resource for health checking this backend
7606 # service. Not all backend services support legacy health checks. See
7607 # Load balancer guide. Currently, at most one health check can be
7608 # specified for each backend service. Backend services with
7609 # instance group or zonal NEG backends must have a health check unless
7610 # haPolicy is specified. Backend services with internet or serverless NEG
7611 # backends must not have a health check.
7612 #
7613 # healthChecks[] cannot be specified with haPolicy.
7614 &quot;A String&quot;,
7615 ],
7616 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
7617 # Not available for internal passthrough Network Load Balancers and external
7618 # passthrough Network Load Balancers.
7619 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
7620 # incoming requests.
7621 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
7622 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
7623 # For security reasons, this value cannot be retrieved via the API.
7624 # Instead, the SHA-256 hash of the value is returned in the
7625 # oauth2ClientSecretSha256 field.
7626 #
7627 # @InputOnly
7628 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
7629 },
7630 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
7631 # defined by the server.
7632 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
7633 # from the client to the backend for proxyless gRPC).
7634 # The possible values are:
7635 #
7636 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
7637 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7638 # Group), regardless of traffic from the client to the proxy. Only IPv4
7639 # health checks are used to check the health of the backends. This is the
7640 # default setting.
7641 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
7642 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
7643 # address).
7644 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
7645 # backend service (Instance Group, Managed Instance Group, Network Endpoint
7646 # Group), regardless of traffic from the client to the proxy. Only IPv6
7647 # health checks are used to check the health of the backends.
7648 #
7649 #
7650 #
7651 # This field is applicable to either:
7652 #
7653 # - Advanced global external Application Load Balancer (load balancing
7654 # scheme EXTERNAL_MANAGED),
7655 # - Regional external Application Load
7656 # Balancer,
7657 # - Internal proxy Network Load Balancer (load balancing
7658 # scheme INTERNAL_MANAGED),
7659 # - Regional internal Application Load
7660 # Balancer (load balancing scheme INTERNAL_MANAGED),
7661 # - Traffic
7662 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
7663 # INTERNAL_SELF_MANAGED).
7664 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
7665 # for backend services.
7666 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
7667 # created for one type of load balancer cannot be used with another.
7668 # For more information, refer toChoosing
7669 # a load balancer.
7670 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
7671 # preference. When you use localityLbPolicies, you must set at least one
7672 # value for either the localityLbPolicies[].policy or the
7673 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
7674 # value set in the localityLbPolicy field.
7675 #
7676 # For an example of how to use this field, seeDefine
7677 # a list of preferred policies.
7678 #
7679 # Caution: This field and its children are intended for use in a service mesh
7680 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
7681 # that have this configuration.
7682 { # Container for either a built-in LB policy supported by gRPC or Envoy or
7683 # a custom one implemented by the end user.
7684 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
7685 # deployed with the client.
7686 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
7687 # by a locally installed custom policy implementation.
7688 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
7689 #
7690 # The value should match the name of a custom implementation registered
7691 # on the gRPC clients. It should follow protocol buffer message naming
7692 # conventions and include the full path (for example,
7693 # myorg.CustomLbPolicy). The maximum length is 256 characters.
7694 #
7695 # Do not specify the same custom policy more than once for a
7696 # backend. If you do, the configuration is rejected.
7697 #
7698 # For an example of how to use this field, seeUse
7699 # a custom policy.
7700 },
7701 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
7702 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
7703 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
7704 # about these values, see the description of localityLbPolicy.
7705 #
7706 # Do not specify the same policy more than once for a
7707 # backend. If you do, the configuration is rejected.
7708 },
7709 },
7710 ],
7711 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
7712 # possible values are:
7713 #
7714 # - ROUND_ROBIN: This is a simple policy in which each healthy
7715 # backend is selected in round robin order. This is the default.
7716 # - LEAST_REQUEST: An O(1) algorithm which
7717 # selects two random healthy hosts and picks the host which has fewer active
7718 # requests.
7719 # - RING_HASH: The ring/modulo hash load balancer implements
7720 # consistent hashing to backends. The algorithm has the property that the
7721 # addition/removal of a host from a set of N hosts only affects 1/N of the
7722 # requests.
7723 # - RANDOM: The load balancer selects a random healthy
7724 # host.
7725 # - ORIGINAL_DESTINATION: Backend host is selected
7726 # based on the client connection metadata, i.e., connections are opened to
7727 # the same address as the destination address of the incoming connection
7728 # before the connection was redirected to the load balancer.
7729 # - MAGLEV: used as a drop in replacement for the ring hash
7730 # load balancer. Maglev is not as stable as ring hash but has faster table
7731 # lookup build times and host selection times. For more information about
7732 # Maglev, see Maglev:
7733 # A Fast and Reliable Software Network Load Balancer.
7734 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
7735 # Load Balancing using weights computed from Backend reported Custom Metrics.
7736 # If set, the Backend Service responses are expected to contain non-standard
7737 # HTTP response header field Endpoint-Load-Metrics. The reported
7738 # metrics to use for computing the weights are specified via thecustomMetrics field.
7739 #
7740 # This field is applicable to either:
7741 # - A regional backend service with the service protocol set to HTTP,
7742 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7743 # INTERNAL_MANAGED.
7744 # - A global backend service with the
7745 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
7746 # EXTERNAL_MANAGED.
7747 #
7748 #
7749 # If sessionAffinity is not configured—that is, if session
7750 # affinity remains at the default value of NONE—then the
7751 # default value for localityLbPolicy
7752 # is ROUND_ROBIN. If session affinity is set to a value other
7753 # than NONE,
7754 # then the default value for localityLbPolicy isMAGLEV.
7755 #
7756 # Only ROUND_ROBIN and RING_HASH are supported
7757 # when the backend service is referenced by a URL map that is bound to
7758 # target gRPC proxy that has validateForProxyless field set to true.
7759 #
7760 # localityLbPolicy cannot be specified with haPolicy.
7761 &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
7762 # by this backend service. If logging is enabled, logs will be exported to
7763 # Stackdriver.
7764 # backend service.
7765 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
7766 # traffic served by this backend service. The default value is false.
7767 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
7768 { # Determines which HTTP headers will be logged to Stackdriver.
7769 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7770 },
7771 ],
7772 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
7773 { # Determines which HTTP headers will be logged to Stackdriver.
7774 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
7775 },
7776 ],
7777 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
7778 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
7779 # of optional fields you want to include in the logs. For example:
7780 # serverInstance, serverGkeDetails.cluster,
7781 # serverGkeDetails.pod.podNamespace
7782 &quot;A String&quot;,
7783 ],
7784 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
7785 # service. Configures whether all, none or a subset of optional fields
7786 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
7787 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
7788 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
7789 # service. The value of the field must be in [0, 1]. This configures the
7790 # sampling rate of requests to the load balancer where 1.0 means all logged
7791 # requests are reported and 0.0 means no logged requests are reported. The
7792 # default value is 1.0.
7793 },
7794 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
7795 # service. Duration is computed from the beginning of the stream until the
7796 # response has been completely processed, including all retries. A stream
7797 # that does not complete in this duration is closed.
7798 #
7799 # If not specified, there will be no timeout limit, i.e. the maximum
7800 # duration is infinite.
7801 #
7802 # This value can be overridden in the PathMatcher configuration of the
7803 # UrlMap that references this backend service.
7804 #
7805 # This field is only allowed when the loadBalancingScheme of
7806 # the backend service is INTERNAL_SELF_MANAGED.
7807 # as a count of seconds and fractions of seconds at nanosecond
7808 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7809 # or &quot;month&quot;. Range is approximately 10,000 years.
7810 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7811 # Durations less than one second are represented with a 0
7812 # `seconds` field and a positive `nanos` field. Must be from 0
7813 # to 999,999,999 inclusive.
7814 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7815 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7816 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7817 },
7818 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
7819 # controller and read by the backend RCTH
7820 &quot;a_key&quot;: &quot;A String&quot;,
7821 },
7822 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
7823 # The name must be 1-63 characters long, and comply withRFC1035.
7824 # Specifically, the name must be 1-63 characters long and match the regular
7825 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
7826 # character must be a lowercase letter, and all following characters must
7827 # be a dash, lowercase letter, or digit, except the last character, which
7828 # cannot be a dash.
7829 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
7830 #
7831 # This field must be set for Internal Passthrough Network Load Balancers when
7832 # the haPolicy is enabled, and for External Passthrough Network Load
7833 # Balancers when the haPolicy fastIpMove is enabled.
7834 #
7835 # 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.
7836 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
7837 # Load Balancers.
7838 #
7839 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
7840 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
7841 # endpoints in the local zone.
7842 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
7843 # possible values are:
7844 #
7845 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
7846 # is disabled. The load balancer distributes new connections to all
7847 # healthy backend endpoints across all zones.
7848 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
7849 # enabled. The load balancer distributes new connections to all healthy
7850 # backend endpoints in the local zone only. If there are no healthy
7851 # backend endpoints in the local zone, the load balancer distributes
7852 # new connections to all backend endpoints in the local zone.
7853 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
7854 # enabled. The load balancer distributes new connections to all healthy
7855 # backend endpoints in the local zone only. If there aren&#x27;t enough
7856 # healthy backend endpoints in the local zone, the load balancer
7857 # distributes new connections to all healthy backend endpoints across all
7858 # zones.
7859 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
7860 # of healthy backend endpoints in a zone to the count of backend
7861 # endpoints in that same zone is equal to or above this threshold, the
7862 # load balancer distributes new connections to all healthy endpoints in
7863 # the local zone only. When the ratio of the count of healthy backend
7864 # endpoints in a zone to the count of backend endpoints in that same
7865 # zone is below this threshold, the load balancer distributes all new
7866 # connections to all healthy endpoints across all zones.
7867 },
7868 },
7869 &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.
7870 # the backend service.
7871 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
7872 # service.
7873 },
7874 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
7875 # load balancing pool of each individual proxy instance that processes the
7876 # traffic for the given backend service. If not set, this feature is
7877 # considered disabled.
7878 #
7879 # Results of the outlier detection algorithm (ejection of endpoints from the
7880 # load balancing pool and returning them back to the pool) are executed
7881 # independently by each proxy instance of the load balancer. In most cases,
7882 # more than one proxy instance handles the traffic received by a backend
7883 # service. Thus, it is possible that an unhealthy endpoint is detected and
7884 # ejected by only some of the proxies, and while this happens, other proxies
7885 # may continue to send requests to the same unhealthy endpoint until they
7886 # detect and eject the unhealthy endpoint.
7887 #
7888 # Applicable backend endpoints can be:
7889 #
7890 # - VM instances in an Instance Group
7891 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
7892 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
7893 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
7894 # Functions Services
7895 # - Private Service Connect NEGs, that resolve to
7896 # Google-managed regional API endpoints or managed services published using
7897 # Private Service Connect
7898 #
7899 #
7900 #
7901 # Applicable backend service types can be:
7902 #
7903 # - A global backend service with the loadBalancingScheme set to
7904 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
7905 # - A regional backend
7906 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
7907 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
7908 # supported for Serverless NEGs.
7909 #
7910 #
7911 #
7912 # Not supported when the backend service is referenced by a URL map that is
7913 # bound to target gRPC proxy that has validateForProxyless field set to true.
7914 # pool for the backend service.
7915 &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
7916 # or 30s.
7917 #
7918 # After a backend endpoint is returned back to the load balancing pool, it
7919 # can be ejected again in another ejection analysis. Thus, the total ejection
7920 # time is equal to the base ejection time multiplied by the number of times
7921 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
7922 # as a count of seconds and fractions of seconds at nanosecond
7923 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7924 # or &quot;month&quot;. Range is approximately 10,000 years.
7925 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7926 # Durations less than one second are represented with a 0
7927 # `seconds` field and a positive `nanos` field. Must be from 0
7928 # to 999,999,999 inclusive.
7929 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7930 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7931 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7932 },
7933 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
7934 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
7935 # return code qualifies as an error. Defaults to 5.
7936 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
7937 # connection errors that are mapped to one of those status codes) before a
7938 # consecutive gateway failure ejection occurs. Defaults to 3.
7939 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7940 # outlier status is detected through consecutive 5xx. This setting can be
7941 # used to disable ejection or to ramp it up slowly. Defaults to 0.
7942 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7943 # outlier status is detected through consecutive gateway failures. This
7944 # setting can be used to disable ejection or to ramp it up slowly. Defaults
7945 # to 100.
7946 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
7947 # outlier status is detected through success rate statistics. This setting
7948 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
7949 #
7950 # Not supported when the backend service uses Serverless NEG.
7951 &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
7952 # ejections and backend endpoints being returned to service. The interval is
7953 # equal to the number of seconds as defined in
7954 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
7955 # in outlierDetection.interval.nanos. Defaults to 1 second.
7956 # as a count of seconds and fractions of seconds at nanosecond
7957 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7958 # or &quot;month&quot;. Range is approximately 10,000 years.
7959 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7960 # Durations less than one second are represented with a 0
7961 # `seconds` field and a positive `nanos` field. Must be from 0
7962 # to 999,999,999 inclusive.
7963 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7964 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7965 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7966 },
7967 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
7968 # backend service that can be ejected if the ejection conditions are met.
7969 # Defaults to 50%.
7970 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
7971 # enough request volume to detect success rate outliers. If the number of
7972 # backend endpoints is fewer than this setting, outlier detection via success
7973 # rate statistics is not performed for any backend endpoint in the load
7974 # balancing pool. Defaults to 5.
7975 #
7976 # Not supported when the backend service uses Serverless NEG.
7977 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
7978 # (as defined by the interval duration above) to include this backend
7979 # endpoint in success rate based outlier detection. If the volume is lower
7980 # than this setting, outlier detection via success rate statistics is not
7981 # performed for that backend endpoint. Defaults to 100.
7982 #
7983 # Not supported when the backend service uses Serverless NEG.
7984 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
7985 # outlier ejection. The ejection threshold is the difference between the mean
7986 # success rate, and the product of this factor and the standard deviation of
7987 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
7988 # is divided by a thousand to get a double. That is, if the desired factor
7989 # is 1.9, the runtime value should be 1900. Defaults to 1900.
7990 #
7991 # Not supported when the backend service uses Serverless NEG.
7992 },
7993 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7994 # as part of resource payload.
7995 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7996 # Tag keys and values have the same definition as resource
7997 # manager tags. The field is allowed for INSERT
7998 # only. The keys/values to set on the resource should be specified in
7999 # either ID { : } or Namespaced format
8000 # { : }.
8001 # For example the following are valid inputs:
8002 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8003 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8004 # Note:
8005 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8006 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8007 &quot;a_key&quot;: &quot;A String&quot;,
8008 },
8009 },
8010 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
8011 # the backend. The default value is 80.
8012 # For internal passthrough Network Load Balancers and external passthrough
8013 # Network Load Balancers, omit port.
8014 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
8015 # communication to the backend VMs in that group. The
8016 # named port must be [defined on each backend instance
8017 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
8018 # This parameter has no meaning if the backends are NEGs. For internal
8019 # passthrough Network Load Balancers and external passthrough Network Load
8020 # Balancers, omit port_name.
8021 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
8022 # with backends.
8023 #
8024 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
8025 # depending on the chosen load balancer or Traffic Director configuration.
8026 # Refer to the documentation for the load balancers or for Traffic Director
8027 # for more information.
8028 #
8029 # Must be set to GRPC when the backend service is referenced by a URL map
8030 # that is bound to target gRPC proxy.
8031 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
8032 # resides. This field is not applicable to global backend services.
8033 # You must specify this field as part of the HTTP request URL. It is
8034 # not settable as a field in the request body.
8035 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
8036 # backend service.
8037 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
8038 # service. This field is applicable to a global backend service with the
8039 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
8040 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
8041 &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
8042 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
8043 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
8044 # private storage buckets that support Signature Version 4 for authentication.
8045 # The service name for generating the authentication header will always default
8046 # to &#x27;s3&#x27;.
8047 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
8048 # creating a backend that uses AWS v4 signature authentication, but will not
8049 # be returned as part of the configuration when queried with a REST API GET
8050 # request.
8051 #
8052 # @InputOnly
8053 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
8054 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
8055 # keep track of different iterations of your access key.
8056 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
8057 # the name of the region your cloud uses to host your origin. For example,
8058 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
8059 },
8060 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
8061 # that describes how clients should authenticate with this service&#x27;s
8062 # backends.
8063 #
8064 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
8065 # to INTERNAL_SELF_MANAGED.
8066 #
8067 # If left blank, communications are not encrypted.
8068 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
8069 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
8070 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
8071 # specified values, the communication continues. Otherwise, it fails. This
8072 # additional check enables the client to verify that the server is authorized
8073 # to run the requested service.
8074 #
8075 # Note that the contents of the server
8076 # certificate&#x27;s subjectAltName field are configured by the
8077 # Public Key Infrastructure which provisions server identities.
8078 #
8079 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
8080 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
8081 # mode).
8082 &quot;A String&quot;,
8083 ],
8084 },
8085 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8086 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
8087 #
8088 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
8089 # If set, lists of backends and health checks must be both empty.
8090 &quot;A String&quot;,
8091 ],
8092 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
8093 #
8094 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
8095 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
8096 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
8097 #
8098 # Only NONE and HEADER_FIELD are supported
8099 # when the backend service is referenced by a URL map that is bound to
8100 # target gRPC proxy that has validateForProxyless field set to true.
8101 #
8102 # For more details, see:
8103 # [Session
8104 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
8105 #
8106 # sessionAffinity cannot be specified with haPolicy.
8107 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
8108 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
8109 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8110 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8111 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8112 # as a count of seconds and fractions of seconds at nanosecond
8113 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8114 # or &quot;month&quot;. Range is approximately 10,000 years.
8115 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8116 # Durations less than one second are represented with a 0
8117 # `seconds` field and a positive `nanos` field. Must be from 0
8118 # to 999,999,999 inclusive.
8119 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8120 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8121 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8122 },
8123 },
8124 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
8125 # Currently this is applicable only for Internal TCP/UDP load balancing,
8126 # Internal HTTP(S) load balancing and Traffic Director.
8127 &quot;policy&quot;: &quot;A String&quot;,
8128 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
8129 # each service mesh client.
8130 #
8131 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
8132 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
8133 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
8134 # `INTERNAL_SELF_MANAGED`.
8135 #
8136 # `subset_size` is optional for Internal HTTP(S) load balancing
8137 # and required for Traffic Director.
8138 #
8139 # If you do not provide this value, Cloud Load Balancing will calculate it
8140 # dynamically to optimize the number of proxies/clients visible to each
8141 # backend and vice versa.
8142 #
8143 # Must be greater than 0. If `subset_size` is larger than the number of
8144 # backends/endpoints, then subsetting is disabled.
8145 },
8146 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
8147 # type of load balancer. For more information see,
8148 # Backend service settings.
8149 # The default is 30 seconds.
8150 # The full range of timeout values allowed goes from 1
8151 # through 2,147,483,647 seconds.
8152 #
8153 # This value can be overridden in the PathMatcher configuration of the
8154 # UrlMap that references this backend service.
8155 #
8156 # Not supported when the backend service is referenced by a URL map that is
8157 # bound to target gRPC proxy that has validateForProxyless field set to true.
8158 # Instead, use maxStreamDuration.
8159 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
8160 # when the backend protocol is SSL, HTTPS or HTTP2.
8161 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
8162 # networksecurity.googleapis.com namespace. Can be used in authenticating
8163 # TLS connections to the backend, as specified by the authenticationMode
8164 # field. Can only be specified if authenticationMode is not NONE.
8165 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
8166 #
8167 #
8168 # Use this property to configure the load balancer back-end to use
8169 # certificates and roots of trust provisioned by the Managed Workload
8170 # Identity system.
8171 #
8172 # The `identity` property is the
8173 # fully-specified SPIFFE ID to use in the SVID presented by the Load
8174 # Balancer Workload.
8175 #
8176 # The SPIFFE ID must be a resource starting with the
8177 # `trustDomain` property value, followed by the path to the Managed
8178 # Workload Identity.
8179 #
8180 # Supported SPIFFE ID format:
8181 #
8182 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
8183 #
8184 #
8185 # The Trust Domain within the Managed Identity must refer to a valid
8186 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
8187 # will be inherited from the Workload Identity Pool.
8188 #
8189 # Restrictions:
8190 #
8191 # - If you set the `identity` property, you cannot manually set
8192 # the following fields:
8193 # - tlsSettings.sni
8194 # - tlsSettings.subjectAltNames
8195 # - tlsSettings.authenticationConfig
8196 #
8197 #
8198 # When defining a `identity` for a RegionBackendServices, the
8199 # corresponding Workload Identity Pool must have a ca_pool
8200 # configured in the same region.
8201 #
8202 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
8203 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
8204 # balancer sends this string as the SNI hostname in the TLS connection to
8205 # the backend, and requires that this string match a Subject Alternative
8206 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
8207 # NEG backend, if the SNI is specified here, the load balancer uses it
8208 # regardless of whether the Regional Internet NEG is specified with FQDN or
8209 # IP address and port. When both sni and subjectAltNames[] are specified,
8210 # the load balancer matches the backend certificate&#x27;s SAN only to
8211 # subjectAltNames[].
8212 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
8213 # verifies during a TLS handshake with the backend. When the server
8214 # presents its X.509 certificate to the Load Balancer, the Load Balancer
8215 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
8216 # match one of the subjectAltNames in the list. This field is limited to 5
8217 # entries. When both sni and subjectAltNames[] are specified, the load
8218 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
8219 { # A Subject Alternative Name that the load balancer matches against the SAN
8220 # field in the TLS certificate provided by the backend, specified as either
8221 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
8222 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
8223 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
8224 },
8225 ],
8226 },
8227 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
8228 {
8229 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
8230 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
8231 # and ForwardingRule.
8232 },
8233 ],
8234 },
8235 ],
8236 &quot;kind&quot;: &quot;compute#backendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.
8237 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
8238 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
8239 # the query parameter pageToken in the next list request.
8240 # Subsequent list requests will have their own nextPageToken to
8241 # continue paging through the results.
8242 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
8243 &quot;warning&quot;: { # [Output Only] Informational warning message.
8244 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8245 # Engine returns NO_RESULTS_ON_PAGE if there
8246 # are no results in the response.
8247 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8248 # value format. For example:
8249 #
8250 # &quot;data&quot;: [
8251 # {
8252 # &quot;key&quot;: &quot;scope&quot;,
8253 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8254 # }
8255 {
8256 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8257 # returned. For example, for warnings where there are no results in a list
8258 # request for a particular zone, this key might be scope and
8259 # the key value might be the zone name. Other examples might be a key
8260 # indicating a deprecated resource and a suggested replacement, or a
8261 # warning about invalid network settings (for example, if an instance
8262 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8263 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8264 },
8265 ],
8266 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8267 },
8268 }</pre>
8269 </div>
8270
8271 <div class="method">
8272 <code class="details" id="listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
8273 <pre>Retrieves a list of all usable backend services in the specified project.
8274
8275 Args:
8276 project: string, Project ID for this request. (required)
8277 filter: string, A filter expression that filters resources listed in the response. Most
8278 Compute resources support two types of filter expressions:
8279 expressions that support regular expressions and expressions that follow
8280 API improvement proposal AIP-160.
8281 These two types of filter expressions cannot be mixed in one request.
8282
8283 If you want to use AIP-160, your expression must specify the field name, an
8284 operator, and the value that you want to use for filtering. The value
8285 must be a string, a number, or a boolean. The operator
8286 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
8287
8288 For example, if you are filtering Compute Engine instances, you can
8289 exclude instances named `example-instance` by specifying
8290 `name != example-instance`.
8291
8292 The `:*` comparison can be used to test whether a key has been defined.
8293 For example, to find all objects with `owner` label use:
8294 ```
8295 labels.owner:*
8296 ```
8297
8298 You can also filter nested fields. For example, you could specify
8299 `scheduling.automaticRestart = false` to include instances only
8300 if they are not scheduled for automatic restarts. You can use filtering
8301 on nested fields to filter based onresource labels.
8302
8303 To filter on multiple expressions, provide each separate expression within
8304 parentheses. For example:
8305 ```
8306 (scheduling.automaticRestart = true)
8307 (cpuPlatform = &quot;Intel Skylake&quot;)
8308 ```
8309 By default, each expression is an `AND` expression. However, you
8310 can include `AND` and `OR` expressions explicitly.
8311 For example:
8312 ```
8313 (cpuPlatform = &quot;Intel Skylake&quot;) OR
8314 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
8315 (scheduling.automaticRestart = true)
8316 ```
8317
8318 If you want to use a regular expression, use the `eq` (equal) or `ne`
8319 (not equal) operator against a single un-parenthesized expression with or
8320 without quotes or against multiple parenthesized expressions. Examples:
8321
8322 `fieldname eq unquoted literal`
8323 `fieldname eq &#x27;single quoted literal&#x27;`
8324 `fieldname eq &quot;double quoted literal&quot;`
8325 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
8326
8327 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
8328 The literal value must match the entire field.
8329
8330 For example, to filter for instances that do not end with name &quot;instance&quot;,
8331 you would use `name ne .*instance`.
8332
8333 You cannot combine constraints on multiple fields using regular
8334 expressions.
8335 maxResults: integer, The maximum number of results per page that should be returned.
8336 If the number of available results is larger than `maxResults`,
8337 Compute Engine returns a `nextPageToken` that can be used to get
8338 the next page of results in subsequent list requests. Acceptable values are
8339 `0` to `500`, inclusive. (Default: `500`)
8340 orderBy: string, Sorts list results by a certain order. By default, results
8341 are returned in alphanumerical order based on the resource name.
8342
8343 You can also sort results in descending order based on the creation
8344 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
8345 results based on the `creationTimestamp` field in
8346 reverse chronological order (newest result first). Use this to sort
8347 resources like operations so that the newest operation is returned first.
8348
8349 Currently, only sorting by `name` or
8350 `creationTimestamp desc` is supported.
8351 pageToken: string, Specifies a page token to use. Set `pageToken` to the
8352 `nextPageToken` returned by a previous list request to get
8353 the next page of results.
8354 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
8355 of failure. The default value is false.
8356
8357 For example, when partial success behavior is enabled, aggregatedList for a
8358 single zone scope either returns all resources in the zone or no resources,
8359 with an error code.
8360 x__xgafv: string, V1 error format.
8361 Allowed values
8362 1 - v1 error format
8363 2 - v2 error format
8364
8365 Returns:
8366 An object of the form:
8367
8368 { # Contains a list of usable BackendService resources.
8369 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
8370 &quot;items&quot;: [ # A list of BackendService resources.
8371 { # Represents a Backend Service resource.
8372 #
8373 # A backend service defines how Google Cloud load balancers distribute traffic.
8374 # The backend service configuration contains a set of values, such as the
8375 # protocol used to connect to backends, various distribution and session
8376 # settings, health checks, and timeouts. These settings provide fine-grained
8377 # control over how your load balancer behaves. Most of the settings have
8378 # default values that allow for easy configuration if you need to get started
8379 # quickly.
8380 #
8381 # Backend services in Google Compute Engine can be either regionally or
8382 # globally scoped.
8383 #
8384 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
8385 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
8386 #
8387 # For more information, seeBackend
8388 # Services.
8389 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
8390 # Load Balancers and Traffic Director and requires
8391 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
8392 #
8393 # If set to 0, the cookie is non-persistent and lasts only until
8394 # the end of the browser session (or equivalent). The maximum allowed value
8395 # is two weeks (1,209,600).
8396 #
8397 # Not supported when the backend service is referenced by a URL map that is
8398 # bound to target gRPC proxy that has validateForProxyless field set to true.
8399 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
8400 { # Message containing information of one individual backend.
8401 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
8402 # handle additional traffic or is fully loaded. For usage guidelines, see
8403 # Connection balancing mode.
8404 #
8405 # Backends must use compatible balancing modes. For more information, see
8406 # Supported balancing modes and target capacity settings and
8407 # Restrictions and guidance for instance groups.
8408 #
8409 # Note: Currently, if you use the API to configure incompatible balancing
8410 # modes, the configuration might be accepted even though it has no impact
8411 # and is ignored. Specifically, Backend.maxUtilization is ignored when
8412 # Backend.balancingMode is RATE. In the future, this incompatible combination
8413 # will be rejected.
8414 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
8415 # mode.
8416 # The default value is 1, which means the group serves up to
8417 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
8418 # completely drained, offering 0% of its available capacity. The valid ranges
8419 # are 0.0 and [0.1,1.0].
8420 # You cannot configure a setting larger than 0 and smaller than0.1.
8421 # You cannot configure a setting of 0 when there is only one
8422 # backend attached to the backend service.
8423 #
8424 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
8425 # internet NEGs, regional serverless NEGs, and PSC NEGs.
8426 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
8427 # BalancingMode.
8428 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
8429 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
8430 # Monitoring, but is not used for load balancing.
8431 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
8432 # balancing mode. The valid range is [0.0, 1.0].
8433 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8434 # long and match the regular expression
8435 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8436 # first character must be a lowercase letter, and all following
8437 # characters must be a dash, period, underscore, lowercase letter, or
8438 # digit, except the last character, which cannot be a dash, period, or
8439 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8440 # field can only be used for a global or regional backend service with the
8441 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8442 },
8443 ],
8444 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8445 # create the resource.
8446 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
8447 # failover backend can be configured for a given BackendService.
8448 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
8449 # group or network endpoint
8450 # group (NEG) resource. To determine what types of backends a load
8451 # balancer supports, see the [Backend services
8452 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
8453 #
8454 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
8455 # or NEG. Partial URLs are not supported.
8456 #
8457 # If haPolicy is specified, backends must refer to NEG resources of type
8458 # GCE_VM_IP.
8459 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8460 # guidelines, seeConnection
8461 # balancing mode and Utilization
8462 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
8463 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8464 # guidelines, seeConnection
8465 # balancing mode and Utilization
8466 # balancing mode.
8467 #
8468 # Not available if the backend&#x27;s balancingMode isRATE.
8469 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
8470 # For usage guidelines, seeConnection
8471 # balancing mode and Utilization
8472 # balancing mode.
8473 #
8474 # Not available if the backend&#x27;s balancingMode isRATE.
8475 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
8476 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
8477 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
8478 # Not available if backend&#x27;s balancingMode is RATE
8479 # or CONNECTION.
8480 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
8481 # Not available if backend&#x27;s balancingMode is RATE
8482 # or CONNECTION.
8483 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
8484 # usage guidelines, seeRate
8485 # balancing mode and Utilization
8486 # balancing mode.
8487 #
8488 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8489 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8490 # guidelines, seeRate
8491 # balancing mode and Utilization
8492 # balancing mode.
8493 #
8494 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8495 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8496 # guidelines, seeRate
8497 # balancing mode and Utilization
8498 # balancing mode.
8499 #
8500 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8501 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
8502 #
8503 # For usage guidelines, seeUtilization
8504 # balancing mode.
8505 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
8506 # the backend.
8507 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
8508 },
8509 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
8510 # sending traffic to backends with default preference. The possible values
8511 # are:
8512 #
8513 # - PREFERRED: Backends with this preference level will be
8514 # filled up to their capacity limits first, based on RTT.
8515 # - DEFAULT: If preferred backends don&#x27;t have enough
8516 # capacity, backends in this layer would be used and traffic would be
8517 # assigned based on the load balancing algorithm you use. This is the
8518 # default
8519 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
8520 # Attachment).
8521 # e.g.
8522 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
8523 # for Cloud Run service.
8524 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
8525 # for PSC Service Attachment.
8526 &quot;trafficDuration&quot;: &quot;A String&quot;,
8527 },
8528 ],
8529 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
8530 # specified load balancer types.
8531 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
8532 # Pragma or Authorization headers. Up to 5 headers can be specified.
8533 # The cache is bypassed for all cdnPolicy.cacheMode settings.
8534 { # Bypass the cache when the specified request headers are present,
8535 # e.g. Pragma or Authorization headers. Values are case insensitive.
8536 # The presence of such a header overrides the cache_mode setting.
8537 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
8538 # Values are case-insensitive.
8539 },
8540 ],
8541 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
8542 # CDN.
8543 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
8544 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
8545 &quot;A String&quot;,
8546 ],
8547 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
8548 # The name=value pair will be used in the cache key Cloud CDN generates.
8549 &quot;A String&quot;,
8550 ],
8551 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
8552 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
8553 # query_string_whitelist and query_string_blacklist. If neither is set, the
8554 # entire query string will be included. If false, the query string will be
8555 # excluded from the cache key entirely.
8556 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
8557 # parameters will be included. Either specify query_string_whitelist or
8558 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8559 # not treated as delimiters.
8560 &quot;A String&quot;,
8561 ],
8562 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
8563 # parameters will be excluded. Either specify query_string_whitelist or
8564 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8565 # not treated as delimiters.
8566 &quot;A String&quot;,
8567 ],
8568 },
8569 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
8570 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
8571 # headers to cache content. Responses without these headers will not be
8572 # cached at Google&#x27;s edge, and will require a full trip to the origin on
8573 # every request, potentially impacting performance and increasing load on
8574 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
8575 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
8576 # Warning: this may result in Cloud CDN caching private,
8577 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
8578 # including common image formats, media (video and audio), and web assets
8579 # (JavaScript and CSS). Requests and responses that are marked as
8580 # uncacheable, as well as dynamic content (including HTML), will not be
8581 # cached.
8582 #
8583 # If no value is provided for cdnPolicy.cacheMode, it defaults
8584 # to CACHE_ALL_STATIC.
8585 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
8586 # used to clamp the max-age (or Expires) value sent to the client. With
8587 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
8588 # response max-age directive, along with a &quot;public&quot; directive. For
8589 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
8590 # from the origin (if specified), or else sets the response max-age
8591 # directive to the lesser of the client_ttl and default_ttl, and also
8592 # ensures a &quot;public&quot; cache-control directive is present.
8593 # If a client TTL is not specified, a default value (1 hour) will be used.
8594 # The maximum allowed value is 31,622,400s (1 year).
8595 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
8596 # responses that do not have an existing valid TTL (max-age or s-maxage).
8597 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8598 # The value of defaultTTL cannot be set to a value greater than that of
8599 # maxTTL, but can be equal.
8600 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
8601 # will overwrite the TTL set in all responses. The maximum allowed value is
8602 # 31,622,400s (1 year), noting that infrequently accessed objects may be
8603 # evicted from the cache before the defined TTL.
8604 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
8605 # origin.
8606 # Cache directives that attempt to set a max-age or s-maxage higher than
8607 # this, or an Expires header more than maxTTL seconds in the future will
8608 # be capped at the value of maxTTL, as if it were the value of an
8609 # s-maxage Cache-Control directive.
8610 # Headers sent to the client will not be modified.
8611 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8612 # The maximum allowed value is 31,622,400s (1 year), noting that
8613 # infrequently accessed objects may be evicted from the cache before
8614 # the defined TTL.
8615 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
8616 # to apply fine-grained caching for common errors or redirects.
8617 # This can reduce the load on your origin and improve end-user
8618 # experience by reducing response latency.
8619 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
8620 # negative caching applies to responses with the specified response code
8621 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
8622 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
8623 # to all responses with the specified response code, and override any
8624 # caching headers.
8625 # By default, Cloud CDN will apply the following default TTLs to these
8626 # status codes:
8627 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
8628 # HTTP 404 (Not Found), 410 (Gone),
8629 # 451 (Unavailable For Legal Reasons): 120s
8630 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
8631 # These defaults can be overridden in negative_caching_policy.
8632 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
8633 # negative_caching must be enabled to configure negative_caching_policy.
8634 # Omitting the policy and leaving negative_caching enabled will use
8635 # Cloud CDN&#x27;s default cache TTLs.
8636 # Note that when specifying an explicit negative_caching_policy, you
8637 # should take care to specify a cache TTL for all response codes
8638 # that you wish to cache. Cloud CDN will not apply any default
8639 # negative caching when a policy exists.
8640 { # Specify CDN TTLs for response error codes.
8641 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
8642 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
8643 # specified as values, and you cannot specify a status code more than
8644 # once.
8645 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
8646 # corresponding status code.
8647 # The maximum allowed value is 1800s (30 minutes), noting that
8648 # infrequently accessed objects may be evicted from the cache before the
8649 # defined TTL.
8650 },
8651 ],
8652 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
8653 # requests into a small number of requests to the origin.
8654 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
8655 # content with the origin, or when an error is encountered when refreshing
8656 # the cache.
8657 # This setting defines the default &quot;max-stale&quot; duration for any cached
8658 # responses that do not specify a max-stale directive. Stale responses that
8659 # exceed the TTL configured here will not be served. The default limit
8660 # (max-stale) is 86400s (1 day), which will allow stale content to be
8661 # served up to this limit beyond the max-age (or s-maxage) of a cached
8662 # response.
8663 # The maximum allowed value is 604800 (1 week).
8664 # Set this to zero (0) to disable serve-while-stale.
8665 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
8666 # considered fresh. After this time period, the response will be
8667 # revalidated before being served. Defaults to 1hr (3600s). When serving
8668 # responses to signed URL requests, Cloud CDN will internally behave as
8669 # though all responses from this backend had a &quot;Cache-Control:
8670 # public, max-age=[TTL]&quot; header, regardless of any existing
8671 # Cache-Control header. The actual headers served in responses will not be
8672 # altered.
8673 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
8674 &quot;A String&quot;,
8675 ],
8676 },
8677 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
8678 # backend service.
8679 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
8680 # as a count of seconds and fractions of seconds at nanosecond
8681 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8682 # or &quot;month&quot;. Range is approximately 10,000 years.
8683 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8684 # Durations less than one second are represented with a 0
8685 # `seconds` field and a positive `nanos` field. Must be from 0
8686 # to 999,999,999 inclusive.
8687 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8688 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8689 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8690 },
8691 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
8692 # there is no limit.
8693 #
8694 # Not supported when the backend service is referenced by a URL map that is
8695 # bound to target gRPC proxy that has validateForProxyless field set to true.
8696 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
8697 # not specified, there is no limit.
8698 #
8699 # Not supported when the backend service is referenced by a URL map that is
8700 # bound to target gRPC proxy that has validateForProxyless field set to true.
8701 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
8702 # service. If not specified, there is no limit.
8703 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
8704 # This parameter is respected by both the HTTP/1.1 and HTTP/2
8705 # implementations. If not specified, there is no limit. Setting this
8706 # parameter to 1 will effectively disable keep alive.
8707 #
8708 # Not supported when the backend service is referenced by a URL map that is
8709 # bound to target gRPC proxy that has validateForProxyless field set to true.
8710 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
8711 # not specified, the default is 1.
8712 #
8713 # Not supported when the backend service is referenced by a URL map that is
8714 # bound to target gRPC proxy that has validateForProxyless field set to true.
8715 },
8716 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
8717 # the client&#x27;s Accept-Encoding header.
8718 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
8719 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
8720 # instance. For supported load balancers and protocols, as described inEnabling
8721 # connection draining.
8722 },
8723 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
8724 # tracking policy settings are only available for external passthrough
8725 # Network Load Balancers and internal passthrough Network Load Balancers.
8726 #
8727 # connectionTrackingPolicy cannot be specified with haPolicy.
8728 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
8729 # value is DEFAULT_FOR_PROTOCOL.
8730 #
8731 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
8732 # persist on unhealthy backends only for connection-oriented protocols
8733 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
8734 # Affinity is configured for 5-tuple. They do not persist forUDP.
8735 #
8736 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
8737 # the existing connections on the unhealthy backend are never persisted on
8738 # the unhealthy backend. They are always diverted to newly selected healthy
8739 # backends (unless all backends are unhealthy).
8740 #
8741 # If set to ALWAYS_PERSIST, existing connections always
8742 # persist on unhealthy backends regardless of protocol and session
8743 # affinity. It is generally not recommended to use this mode overriding the
8744 # default.
8745 #
8746 # For more details, see [Connection Persistence for Network Load
8747 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
8748 # and [Connection Persistence for Internal TCP/UDP Load
8749 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
8750 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
8751 # Balancers. This option is not available publicly.
8752 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
8753 # matching traffic (in seconds).
8754 #
8755 # For internal passthrough Network Load Balancers:
8756 #
8757 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
8758 # - It can be set only if Connection Tracking is less than 5-tuple
8759 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
8760 # Mode is PER_SESSION).
8761 #
8762 #
8763 #
8764 # For external passthrough Network Load Balancers the default is 60
8765 # seconds. This option is not available publicly.
8766 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
8767 # options:
8768 #
8769 # - PER_CONNECTION: This is the default mode. The Connection
8770 # Tracking is performed as per the Connection Key (default Hash Method) for
8771 # the specific protocol.
8772 # - PER_SESSION: The Connection Tracking is performed as per
8773 # the configured Session Affinity. It matches the configured Session
8774 # Affinity.
8775 #
8776 #
8777 #
8778 # For more details, see [Tracking Mode for Network Load
8779 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
8780 # and [Tracking Mode for Internal TCP/UDP Load
8781 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
8782 },
8783 &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
8784 # affinity based on HTTP headers, cookies or other properties. This load
8785 # balancing policy is applicable only for HTTP connections. The affinity to a
8786 # particular destination host will be lost when one or more hosts are
8787 # added/removed from the destination service. This field specifies parameters
8788 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
8789 #
8790 # This field is applicable to either:
8791 #
8792 # - A regional backend service with the service protocol set to HTTP,
8793 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
8794 # INTERNAL_MANAGED.
8795 # - A global backend service with the
8796 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
8797 &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
8798 # be used as the hash key for the consistent hash load balancer. If the
8799 # cookie is not present, it will be generated. This field is applicable if
8800 # the sessionAffinity is set to HTTP_COOKIE.
8801 #
8802 # Not supported when the backend service is referenced by a URL map that is
8803 # bound to target gRPC proxy that has validateForProxyless field set to true.
8804 # for load balancing policies that use a consistent hash.
8805 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8806 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8807 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8808 # as a count of seconds and fractions of seconds at nanosecond
8809 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8810 # or &quot;month&quot;. Range is approximately 10,000 years.
8811 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8812 # Durations less than one second are represented with a 0
8813 # `seconds` field and a positive `nanos` field. Must be from 0
8814 # to 999,999,999 inclusive.
8815 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8816 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8817 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8818 },
8819 },
8820 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
8821 # applicable if the sessionAffinity is set toHEADER_FIELD.
8822 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
8823 # 1024. Larger ring sizes result in more granular load distributions. If the
8824 # number of hosts in the load balancing pool is larger than the ring size,
8825 # each host will be assigned a single virtual node.
8826 },
8827 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8828 # text format.
8829 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
8830 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
8831 # locality_lb_policy.
8832 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
8833 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8834 # long and match the regular expression
8835 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8836 # first character must be a lowercase letter, and all following
8837 # characters must be a dash, period, underscore, lowercase letter, or
8838 # digit, except the last character, which cannot be a dash, period, or
8839 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8840 # field can only be used for a global or regional backend service with the
8841 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8842 },
8843 ],
8844 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
8845 # custom
8846 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
8847 &quot;A String&quot;,
8848 ],
8849 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
8850 # custom
8851 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
8852 &quot;A String&quot;,
8853 ],
8854 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8855 # create the resource.
8856 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
8857 # backend service with dynamic forwarding feature which together with Service
8858 # Extension allows customized and complex routing logic.
8859 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
8860 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
8861 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
8862 },
8863 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
8864 # service. Some ranges are restricted: Restricted
8865 # ranges.
8866 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
8867 },
8868 },
8869 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
8870 # this backend service.
8871 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
8872 # global external Application Load Balancer.
8873 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
8874 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
8875 #
8876 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
8877 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
8878 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
8879 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
8880 # externalManagedMigrationTestingPercentage.
8881 #
8882 # Rolling back a migration requires the states to be set in reverse order. So
8883 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
8884 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
8885 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
8886 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
8887 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
8888 # external Application Load Balancer.
8889 #
8890 # The value of this field must be in the range [0, 100].
8891 #
8892 # Session affinity options will slightly affect this routing behavior, for
8893 # more details, see:Session
8894 # Affinity.
8895 #
8896 # This value can only be set if the loadBalancingScheme in the BackendService
8897 # is set to EXTERNAL (when using the classic Application Load Balancer) and
8898 # the migration state is TEST_BY_PERCENTAGE.
8899 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
8900 # as a backup (failover) backend.
8901 # For load balancers that have configurable failover:
8902 # [Internal passthrough Network Load
8903 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8904 # and [external passthrough Network Load
8905 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8906 #
8907 # failoverPolicy cannot be specified with haPolicy.
8908 # failover:
8909 # [Internal passthrough Network Load
8910 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8911 # and [external passthrough
8912 # Network Load
8913 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8914 # On failover or failback, this field indicates whether connection draining
8915 # will be honored. Google Cloud has a fixed connection draining timeout of
8916 # 10 minutes. A setting of true terminates existing TCP
8917 # connections to the active pool during failover and failback, immediately
8918 # draining traffic. A setting of false allows existing TCP
8919 # connections to persist, even on VMs no longer in the active pool, for up
8920 # to the duration of the connection draining timeout (10 minutes).
8921 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
8922 #
8923 # The default is false.
8924 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
8925 # load balancer are dropped when all primary and all backup backend VMs are
8926 # unhealthy.If set to false, connections are distributed
8927 # among all primary VMs when all primary and all backup backend VMs are
8928 # unhealthy.
8929 # For load balancers that have configurable
8930 # failover:
8931 # [Internal passthrough
8932 # Network Load
8933 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8934 # and [external passthrough
8935 # Network Load
8936 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8937 # The default is false.
8938 &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
8939 # failover when the number of healthy primary VMs equals zero.
8940 # For all other values, the load balancer performs a failover when the
8941 # total number of healthy primary VMs is less than this ratio.
8942 # For load balancers that have configurable
8943 # failover:
8944 # [Internal TCP/UDP Load
8945 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
8946 # and [external TCP/UDP Load
8947 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
8948 },
8949 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
8950 # This field is used in optimistic locking. This field will be ignored when
8951 # inserting a BackendService. An up-to-date fingerprint must be provided in
8952 # order to update the BackendService, otherwise the request will
8953 # fail with error 412 conditionNotMet.
8954 #
8955 # To see the latest fingerprint, make a get() request to
8956 # retrieve a BackendService.
8957 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
8958 # Protocol Forwarding.
8959 #
8960 # The backends of this regional backend service must only specify zonal
8961 # network endpoint groups (NEGs) of type GCE_VM_IP.
8962 #
8963 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
8964 # regional backend service must set the network field. All zonal NEGs must
8965 # belong to the same network. However, individual NEGs can
8966 # belong to different subnetworks of that network.
8967 #
8968 # When haPolicy is specified, the set of attached network endpoints across
8969 # all backends comprise an High Availability domain from which one endpoint
8970 # is selected as the active endpoint (the leader) that receives all
8971 # traffic.
8972 #
8973 # haPolicy can be added only at backend service creation time. Once set up,
8974 # it cannot be deleted.
8975 #
8976 # Note that haPolicy is not for load balancing, and therefore cannot be
8977 # specified with sessionAffinity, connectionTrackingPolicy, and
8978 # failoverPolicy.
8979 #
8980 # haPolicy requires customers to be responsible for tracking backend
8981 # endpoint health and electing a leader among the healthy endpoints.
8982 # Therefore, haPolicy cannot be specified with healthChecks.
8983 #
8984 # haPolicy can only be specified for External Passthrough Network Load
8985 # Balancers and Internal Passthrough Network Load Balancers.
8986 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
8987 # achieve it.
8988 #
8989 # Supported values are:
8990 #
8991 # - DISABLED: Fast IP Move is disabled. You can only use the
8992 # haPolicy.leader API to update the leader.
8993 # - &gt;GARP_RA: Provides a method to very quickly define a new network
8994 # endpoint as the leader. This method is faster than updating the leader
8995 # using the haPolicy.leader API. Fast IP move works as follows: The VM
8996 # hosting the network endpoint that should become the new leader sends
8997 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
8998 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
8999 # temporarily associates the forwarding rule IP address with that VM, and
9000 # both new and in-flight packets are quickly delivered to that VM.
9001 #
9002 #
9003 #
9004 # Note the important properties of the Fast IP Move functionality:
9005 #
9006 # - The GARP/RA-initiated re-routing stays active for approximately 20
9007 # minutes. After triggering fast failover, you must also
9008 # appropriately set the haPolicy.leader.
9009 # - The new leader instance should continue to send GARP/RA packets
9010 # periodically every 10 seconds until at least 10 minutes after updating
9011 # the haPolicy.leader (but stop immediately if it is no longer the leader).
9012 # - After triggering a fast failover, we recommend that you wait at least
9013 # 3 seconds before sending another GARP/RA packet from a different VM
9014 # instance to avoid race conditions.
9015 # - Don&#x27;t send GARP/RA packets from different VM
9016 # instances at the same time. If multiple instances continue to send
9017 # GARP/RA packets, traffic might be routed to different destinations in an
9018 # alternating order. This condition ceases when a single instance
9019 # issues a GARP/RA packet.
9020 # - The GARP/RA request always takes priority over the leader API.
9021 # Using the haPolicy.leader API to change the leader to a different
9022 # instance will have no effect until the GARP/RA request becomes
9023 # inactive.
9024 # - The GARP/RA packets should follow the GARP/RA
9025 # Packet Specifications..
9026 # - When multiple forwarding rules refer to a regional backend service,
9027 # you need only send a GARP or RA packet for a single forwarding rule
9028 # virtual IP. The virtual IPs for all forwarding rules targeting the same
9029 # backend service will also be moved to the sender of the GARP or RA
9030 # packet.
9031 #
9032 #
9033 #
9034 # The following are the Fast IP Move limitations (that is, when fastIPMove
9035 # is not DISABLED):
9036 #
9037 # - Multiple forwarding rules cannot use the same IP address if one of
9038 # them refers to a regional backend service with fastIPMove.
9039 # - The regional backend service must set the network field, and all
9040 # NEGs must belong to that network. However, individual
9041 # NEGs can belong to different subnetworks of that network.
9042 # - The maximum number of network endpoints across all backends of a
9043 # backend service with fastIPMove is 32.
9044 # - The maximum number of backend services with fastIPMove that can have
9045 # the same network endpoint attached to one of its backends is 64.
9046 # - The maximum number of backend services with fastIPMove in a VPC in a
9047 # region is 64.
9048 # - The network endpoints that are attached to a backend of a backend
9049 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
9050 # - Traffic directed to the leader by a static route next hop will not be
9051 # redirected to a new leader by fast failover. Such traffic will only be
9052 # redirected once an haPolicy.leader update has taken effect. Only traffic
9053 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
9054 # fast failover.
9055 #
9056 #
9057 # haPolicy.fastIPMove can be set only at backend service creation time.
9058 # Once set, it cannot be updated.
9059 #
9060 # By default, fastIpMove is set to DISABLED.
9061 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
9062 # this service as the active endpoint (the leader) that receives all
9063 # traffic.
9064 #
9065 # When the leader changes, there is no connection draining to persist
9066 # existing connections on the old leader.
9067 #
9068 # You are responsible for selecting a suitable endpoint as the
9069 # leader. For example, preferring a healthy endpoint over unhealthy ones.
9070 # Note that this service does not track backend endpoint health, and
9071 # selects the configured leader unconditionally.
9072 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
9073 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
9074 # that the leader is attached to.
9075 #
9076 # The leader&#x27;s backendGroup must already be specified as a backend of
9077 # this backend service. Removing a backend that is designated as the
9078 # leader&#x27;s backendGroup is not permitted.
9079 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
9080 # designated as the leader.
9081 #
9082 # This network endpoint cannot be detached from the NEG specified in
9083 # the haPolicy.leader.backendGroup until the leader is updated with
9084 # another network endpoint, or the leader is removed from the haPolicy.
9085 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
9086 # instance must already be attached to the NEG specified in the
9087 # haPolicy.leader.backendGroup.
9088 #
9089 # The name must be 1-63 characters long, and comply with RFC1035.
9090 # Authorization requires the following IAM permission on the
9091 # specified resource instance: compute.instances.use
9092 },
9093 },
9094 },
9095 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
9096 # httpsHealthChecks (legacy) resource for health checking this backend
9097 # service. Not all backend services support legacy health checks. See
9098 # Load balancer guide. Currently, at most one health check can be
9099 # specified for each backend service. Backend services with
9100 # instance group or zonal NEG backends must have a health check unless
9101 # haPolicy is specified. Backend services with internet or serverless NEG
9102 # backends must not have a health check.
9103 #
9104 # healthChecks[] cannot be specified with haPolicy.
9105 &quot;A String&quot;,
9106 ],
9107 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
9108 # Not available for internal passthrough Network Load Balancers and external
9109 # passthrough Network Load Balancers.
9110 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
9111 # incoming requests.
9112 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
9113 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
9114 # For security reasons, this value cannot be retrieved via the API.
9115 # Instead, the SHA-256 hash of the value is returned in the
9116 # oauth2ClientSecretSha256 field.
9117 #
9118 # @InputOnly
9119 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
9120 },
9121 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
9122 # defined by the server.
9123 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
9124 # from the client to the backend for proxyless gRPC).
9125 # The possible values are:
9126 #
9127 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
9128 # backend service (Instance Group, Managed Instance Group, Network Endpoint
9129 # Group), regardless of traffic from the client to the proxy. Only IPv4
9130 # health checks are used to check the health of the backends. This is the
9131 # default setting.
9132 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
9133 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
9134 # address).
9135 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
9136 # backend service (Instance Group, Managed Instance Group, Network Endpoint
9137 # Group), regardless of traffic from the client to the proxy. Only IPv6
9138 # health checks are used to check the health of the backends.
9139 #
9140 #
9141 #
9142 # This field is applicable to either:
9143 #
9144 # - Advanced global external Application Load Balancer (load balancing
9145 # scheme EXTERNAL_MANAGED),
9146 # - Regional external Application Load
9147 # Balancer,
9148 # - Internal proxy Network Load Balancer (load balancing
9149 # scheme INTERNAL_MANAGED),
9150 # - Regional internal Application Load
9151 # Balancer (load balancing scheme INTERNAL_MANAGED),
9152 # - Traffic
9153 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
9154 # INTERNAL_SELF_MANAGED).
9155 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
9156 # for backend services.
9157 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
9158 # created for one type of load balancer cannot be used with another.
9159 # For more information, refer toChoosing
9160 # a load balancer.
9161 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
9162 # preference. When you use localityLbPolicies, you must set at least one
9163 # value for either the localityLbPolicies[].policy or the
9164 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
9165 # value set in the localityLbPolicy field.
9166 #
9167 # For an example of how to use this field, seeDefine
9168 # a list of preferred policies.
9169 #
9170 # Caution: This field and its children are intended for use in a service mesh
9171 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
9172 # that have this configuration.
9173 { # Container for either a built-in LB policy supported by gRPC or Envoy or
9174 # a custom one implemented by the end user.
9175 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
9176 # deployed with the client.
9177 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
9178 # by a locally installed custom policy implementation.
9179 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
9180 #
9181 # The value should match the name of a custom implementation registered
9182 # on the gRPC clients. It should follow protocol buffer message naming
9183 # conventions and include the full path (for example,
9184 # myorg.CustomLbPolicy). The maximum length is 256 characters.
9185 #
9186 # Do not specify the same custom policy more than once for a
9187 # backend. If you do, the configuration is rejected.
9188 #
9189 # For an example of how to use this field, seeUse
9190 # a custom policy.
9191 },
9192 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
9193 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
9194 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
9195 # about these values, see the description of localityLbPolicy.
9196 #
9197 # Do not specify the same policy more than once for a
9198 # backend. If you do, the configuration is rejected.
9199 },
9200 },
9201 ],
9202 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
9203 # possible values are:
9204 #
9205 # - ROUND_ROBIN: This is a simple policy in which each healthy
9206 # backend is selected in round robin order. This is the default.
9207 # - LEAST_REQUEST: An O(1) algorithm which
9208 # selects two random healthy hosts and picks the host which has fewer active
9209 # requests.
9210 # - RING_HASH: The ring/modulo hash load balancer implements
9211 # consistent hashing to backends. The algorithm has the property that the
9212 # addition/removal of a host from a set of N hosts only affects 1/N of the
9213 # requests.
9214 # - RANDOM: The load balancer selects a random healthy
9215 # host.
9216 # - ORIGINAL_DESTINATION: Backend host is selected
9217 # based on the client connection metadata, i.e., connections are opened to
9218 # the same address as the destination address of the incoming connection
9219 # before the connection was redirected to the load balancer.
9220 # - MAGLEV: used as a drop in replacement for the ring hash
9221 # load balancer. Maglev is not as stable as ring hash but has faster table
9222 # lookup build times and host selection times. For more information about
9223 # Maglev, see Maglev:
9224 # A Fast and Reliable Software Network Load Balancer.
9225 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
9226 # Load Balancing using weights computed from Backend reported Custom Metrics.
9227 # If set, the Backend Service responses are expected to contain non-standard
9228 # HTTP response header field Endpoint-Load-Metrics. The reported
9229 # metrics to use for computing the weights are specified via thecustomMetrics field.
9230 #
9231 # This field is applicable to either:
9232 # - A regional backend service with the service protocol set to HTTP,
9233 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
9234 # INTERNAL_MANAGED.
9235 # - A global backend service with the
9236 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
9237 # EXTERNAL_MANAGED.
9238 #
9239 #
9240 # If sessionAffinity is not configured—that is, if session
9241 # affinity remains at the default value of NONE—then the
9242 # default value for localityLbPolicy
9243 # is ROUND_ROBIN. If session affinity is set to a value other
9244 # than NONE,
9245 # then the default value for localityLbPolicy isMAGLEV.
9246 #
9247 # Only ROUND_ROBIN and RING_HASH are supported
9248 # when the backend service is referenced by a URL map that is bound to
9249 # target gRPC proxy that has validateForProxyless field set to true.
9250 #
9251 # localityLbPolicy cannot be specified with haPolicy.
9252 &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
9253 # by this backend service. If logging is enabled, logs will be exported to
9254 # Stackdriver.
9255 # backend service.
9256 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
9257 # traffic served by this backend service. The default value is false.
9258 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
9259 { # Determines which HTTP headers will be logged to Stackdriver.
9260 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9261 },
9262 ],
9263 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
9264 { # Determines which HTTP headers will be logged to Stackdriver.
9265 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9266 },
9267 ],
9268 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
9269 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
9270 # of optional fields you want to include in the logs. For example:
9271 # serverInstance, serverGkeDetails.cluster,
9272 # serverGkeDetails.pod.podNamespace
9273 &quot;A String&quot;,
9274 ],
9275 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
9276 # service. Configures whether all, none or a subset of optional fields
9277 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
9278 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
9279 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
9280 # service. The value of the field must be in [0, 1]. This configures the
9281 # sampling rate of requests to the load balancer where 1.0 means all logged
9282 # requests are reported and 0.0 means no logged requests are reported. The
9283 # default value is 1.0.
9284 },
9285 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
9286 # service. Duration is computed from the beginning of the stream until the
9287 # response has been completely processed, including all retries. A stream
9288 # that does not complete in this duration is closed.
9289 #
9290 # If not specified, there will be no timeout limit, i.e. the maximum
9291 # duration is infinite.
9292 #
9293 # This value can be overridden in the PathMatcher configuration of the
9294 # UrlMap that references this backend service.
9295 #
9296 # This field is only allowed when the loadBalancingScheme of
9297 # the backend service is INTERNAL_SELF_MANAGED.
9298 # as a count of seconds and fractions of seconds at nanosecond
9299 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9300 # or &quot;month&quot;. Range is approximately 10,000 years.
9301 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9302 # Durations less than one second are represented with a 0
9303 # `seconds` field and a positive `nanos` field. Must be from 0
9304 # to 999,999,999 inclusive.
9305 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9306 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9307 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9308 },
9309 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
9310 # controller and read by the backend RCTH
9311 &quot;a_key&quot;: &quot;A String&quot;,
9312 },
9313 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
9314 # The name must be 1-63 characters long, and comply withRFC1035.
9315 # Specifically, the name must be 1-63 characters long and match the regular
9316 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
9317 # character must be a lowercase letter, and all following characters must
9318 # be a dash, lowercase letter, or digit, except the last character, which
9319 # cannot be a dash.
9320 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
9321 #
9322 # This field must be set for Internal Passthrough Network Load Balancers when
9323 # the haPolicy is enabled, and for External Passthrough Network Load
9324 # Balancers when the haPolicy fastIpMove is enabled.
9325 #
9326 # 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.
9327 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
9328 # Load Balancers.
9329 #
9330 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
9331 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
9332 # endpoints in the local zone.
9333 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
9334 # possible values are:
9335 #
9336 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
9337 # is disabled. The load balancer distributes new connections to all
9338 # healthy backend endpoints across all zones.
9339 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
9340 # enabled. The load balancer distributes new connections to all healthy
9341 # backend endpoints in the local zone only. If there are no healthy
9342 # backend endpoints in the local zone, the load balancer distributes
9343 # new connections to all backend endpoints in the local zone.
9344 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
9345 # enabled. The load balancer distributes new connections to all healthy
9346 # backend endpoints in the local zone only. If there aren&#x27;t enough
9347 # healthy backend endpoints in the local zone, the load balancer
9348 # distributes new connections to all healthy backend endpoints across all
9349 # zones.
9350 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
9351 # of healthy backend endpoints in a zone to the count of backend
9352 # endpoints in that same zone is equal to or above this threshold, the
9353 # load balancer distributes new connections to all healthy endpoints in
9354 # the local zone only. When the ratio of the count of healthy backend
9355 # endpoints in a zone to the count of backend endpoints in that same
9356 # zone is below this threshold, the load balancer distributes all new
9357 # connections to all healthy endpoints across all zones.
9358 },
9359 },
9360 &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.
9361 # the backend service.
9362 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
9363 # service.
9364 },
9365 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
9366 # load balancing pool of each individual proxy instance that processes the
9367 # traffic for the given backend service. If not set, this feature is
9368 # considered disabled.
9369 #
9370 # Results of the outlier detection algorithm (ejection of endpoints from the
9371 # load balancing pool and returning them back to the pool) are executed
9372 # independently by each proxy instance of the load balancer. In most cases,
9373 # more than one proxy instance handles the traffic received by a backend
9374 # service. Thus, it is possible that an unhealthy endpoint is detected and
9375 # ejected by only some of the proxies, and while this happens, other proxies
9376 # may continue to send requests to the same unhealthy endpoint until they
9377 # detect and eject the unhealthy endpoint.
9378 #
9379 # Applicable backend endpoints can be:
9380 #
9381 # - VM instances in an Instance Group
9382 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
9383 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
9384 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
9385 # Functions Services
9386 # - Private Service Connect NEGs, that resolve to
9387 # Google-managed regional API endpoints or managed services published using
9388 # Private Service Connect
9389 #
9390 #
9391 #
9392 # Applicable backend service types can be:
9393 #
9394 # - A global backend service with the loadBalancingScheme set to
9395 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
9396 # - A regional backend
9397 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
9398 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
9399 # supported for Serverless NEGs.
9400 #
9401 #
9402 #
9403 # Not supported when the backend service is referenced by a URL map that is
9404 # bound to target gRPC proxy that has validateForProxyless field set to true.
9405 # pool for the backend service.
9406 &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
9407 # or 30s.
9408 #
9409 # After a backend endpoint is returned back to the load balancing pool, it
9410 # can be ejected again in another ejection analysis. Thus, the total ejection
9411 # time is equal to the base ejection time multiplied by the number of times
9412 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
9413 # as a count of seconds and fractions of seconds at nanosecond
9414 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9415 # or &quot;month&quot;. Range is approximately 10,000 years.
9416 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9417 # Durations less than one second are represented with a 0
9418 # `seconds` field and a positive `nanos` field. Must be from 0
9419 # to 999,999,999 inclusive.
9420 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9421 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9422 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9423 },
9424 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
9425 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
9426 # return code qualifies as an error. Defaults to 5.
9427 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
9428 # connection errors that are mapped to one of those status codes) before a
9429 # consecutive gateway failure ejection occurs. Defaults to 3.
9430 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9431 # outlier status is detected through consecutive 5xx. This setting can be
9432 # used to disable ejection or to ramp it up slowly. Defaults to 0.
9433 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9434 # outlier status is detected through consecutive gateway failures. This
9435 # setting can be used to disable ejection or to ramp it up slowly. Defaults
9436 # to 100.
9437 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9438 # outlier status is detected through success rate statistics. This setting
9439 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
9440 #
9441 # Not supported when the backend service uses Serverless NEG.
9442 &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
9443 # ejections and backend endpoints being returned to service. The interval is
9444 # equal to the number of seconds as defined in
9445 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
9446 # in outlierDetection.interval.nanos. Defaults to 1 second.
9447 # as a count of seconds and fractions of seconds at nanosecond
9448 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9449 # or &quot;month&quot;. Range is approximately 10,000 years.
9450 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9451 # Durations less than one second are represented with a 0
9452 # `seconds` field and a positive `nanos` field. Must be from 0
9453 # to 999,999,999 inclusive.
9454 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9455 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9456 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9457 },
9458 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
9459 # backend service that can be ejected if the ejection conditions are met.
9460 # Defaults to 50%.
9461 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
9462 # enough request volume to detect success rate outliers. If the number of
9463 # backend endpoints is fewer than this setting, outlier detection via success
9464 # rate statistics is not performed for any backend endpoint in the load
9465 # balancing pool. Defaults to 5.
9466 #
9467 # Not supported when the backend service uses Serverless NEG.
9468 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
9469 # (as defined by the interval duration above) to include this backend
9470 # endpoint in success rate based outlier detection. If the volume is lower
9471 # than this setting, outlier detection via success rate statistics is not
9472 # performed for that backend endpoint. Defaults to 100.
9473 #
9474 # Not supported when the backend service uses Serverless NEG.
9475 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
9476 # outlier ejection. The ejection threshold is the difference between the mean
9477 # success rate, and the product of this factor and the standard deviation of
9478 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
9479 # is divided by a thousand to get a double. That is, if the desired factor
9480 # is 1.9, the runtime value should be 1900. Defaults to 1900.
9481 #
9482 # Not supported when the backend service uses Serverless NEG.
9483 },
9484 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
9485 # as part of resource payload.
9486 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
9487 # Tag keys and values have the same definition as resource
9488 # manager tags. The field is allowed for INSERT
9489 # only. The keys/values to set on the resource should be specified in
9490 # either ID { : } or Namespaced format
9491 # { : }.
9492 # For example the following are valid inputs:
9493 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
9494 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
9495 # Note:
9496 # * Invalid combinations of ID &amp; namespaced format is not supported. For
9497 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
9498 &quot;a_key&quot;: &quot;A String&quot;,
9499 },
9500 },
9501 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
9502 # the backend. The default value is 80.
9503 # For internal passthrough Network Load Balancers and external passthrough
9504 # Network Load Balancers, omit port.
9505 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
9506 # communication to the backend VMs in that group. The
9507 # named port must be [defined on each backend instance
9508 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
9509 # This parameter has no meaning if the backends are NEGs. For internal
9510 # passthrough Network Load Balancers and external passthrough Network Load
9511 # Balancers, omit port_name.
9512 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
9513 # with backends.
9514 #
9515 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
9516 # depending on the chosen load balancer or Traffic Director configuration.
9517 # Refer to the documentation for the load balancers or for Traffic Director
9518 # for more information.
9519 #
9520 # Must be set to GRPC when the backend service is referenced by a URL map
9521 # that is bound to target gRPC proxy.
9522 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
9523 # resides. This field is not applicable to global backend services.
9524 # You must specify this field as part of the HTTP request URL. It is
9525 # not settable as a field in the request body.
9526 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
9527 # backend service.
9528 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
9529 # service. This field is applicable to a global backend service with the
9530 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
9531 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
9532 &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
9533 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
9534 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
9535 # private storage buckets that support Signature Version 4 for authentication.
9536 # The service name for generating the authentication header will always default
9537 # to &#x27;s3&#x27;.
9538 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
9539 # creating a backend that uses AWS v4 signature authentication, but will not
9540 # be returned as part of the configuration when queried with a REST API GET
9541 # request.
9542 #
9543 # @InputOnly
9544 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
9545 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
9546 # keep track of different iterations of your access key.
9547 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
9548 # the name of the region your cloud uses to host your origin. For example,
9549 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
9550 },
9551 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
9552 # that describes how clients should authenticate with this service&#x27;s
9553 # backends.
9554 #
9555 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
9556 # to INTERNAL_SELF_MANAGED.
9557 #
9558 # If left blank, communications are not encrypted.
9559 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
9560 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
9561 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
9562 # specified values, the communication continues. Otherwise, it fails. This
9563 # additional check enables the client to verify that the server is authorized
9564 # to run the requested service.
9565 #
9566 # Note that the contents of the server
9567 # certificate&#x27;s subjectAltName field are configured by the
9568 # Public Key Infrastructure which provisions server identities.
9569 #
9570 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
9571 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
9572 # mode).
9573 &quot;A String&quot;,
9574 ],
9575 },
9576 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9577 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
9578 #
9579 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
9580 # If set, lists of backends and health checks must be both empty.
9581 &quot;A String&quot;,
9582 ],
9583 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
9584 #
9585 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
9586 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
9587 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
9588 #
9589 # Only NONE and HEADER_FIELD are supported
9590 # when the backend service is referenced by a URL map that is bound to
9591 # target gRPC proxy that has validateForProxyless field set to true.
9592 #
9593 # For more details, see:
9594 # [Session
9595 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
9596 #
9597 # sessionAffinity cannot be specified with haPolicy.
9598 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
9599 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
9600 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
9601 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
9602 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
9603 # as a count of seconds and fractions of seconds at nanosecond
9604 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9605 # or &quot;month&quot;. Range is approximately 10,000 years.
9606 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9607 # Durations less than one second are represented with a 0
9608 # `seconds` field and a positive `nanos` field. Must be from 0
9609 # to 999,999,999 inclusive.
9610 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9611 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9612 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9613 },
9614 },
9615 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
9616 # Currently this is applicable only for Internal TCP/UDP load balancing,
9617 # Internal HTTP(S) load balancing and Traffic Director.
9618 &quot;policy&quot;: &quot;A String&quot;,
9619 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
9620 # each service mesh client.
9621 #
9622 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
9623 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
9624 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
9625 # `INTERNAL_SELF_MANAGED`.
9626 #
9627 # `subset_size` is optional for Internal HTTP(S) load balancing
9628 # and required for Traffic Director.
9629 #
9630 # If you do not provide this value, Cloud Load Balancing will calculate it
9631 # dynamically to optimize the number of proxies/clients visible to each
9632 # backend and vice versa.
9633 #
9634 # Must be greater than 0. If `subset_size` is larger than the number of
9635 # backends/endpoints, then subsetting is disabled.
9636 },
9637 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
9638 # type of load balancer. For more information see,
9639 # Backend service settings.
9640 # The default is 30 seconds.
9641 # The full range of timeout values allowed goes from 1
9642 # through 2,147,483,647 seconds.
9643 #
9644 # This value can be overridden in the PathMatcher configuration of the
9645 # UrlMap that references this backend service.
9646 #
9647 # Not supported when the backend service is referenced by a URL map that is
9648 # bound to target gRPC proxy that has validateForProxyless field set to true.
9649 # Instead, use maxStreamDuration.
9650 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
9651 # when the backend protocol is SSL, HTTPS or HTTP2.
9652 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
9653 # networksecurity.googleapis.com namespace. Can be used in authenticating
9654 # TLS connections to the backend, as specified by the authenticationMode
9655 # field. Can only be specified if authenticationMode is not NONE.
9656 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
9657 #
9658 #
9659 # Use this property to configure the load balancer back-end to use
9660 # certificates and roots of trust provisioned by the Managed Workload
9661 # Identity system.
9662 #
9663 # The `identity` property is the
9664 # fully-specified SPIFFE ID to use in the SVID presented by the Load
9665 # Balancer Workload.
9666 #
9667 # The SPIFFE ID must be a resource starting with the
9668 # `trustDomain` property value, followed by the path to the Managed
9669 # Workload Identity.
9670 #
9671 # Supported SPIFFE ID format:
9672 #
9673 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
9674 #
9675 #
9676 # The Trust Domain within the Managed Identity must refer to a valid
9677 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
9678 # will be inherited from the Workload Identity Pool.
9679 #
9680 # Restrictions:
9681 #
9682 # - If you set the `identity` property, you cannot manually set
9683 # the following fields:
9684 # - tlsSettings.sni
9685 # - tlsSettings.subjectAltNames
9686 # - tlsSettings.authenticationConfig
9687 #
9688 #
9689 # When defining a `identity` for a RegionBackendServices, the
9690 # corresponding Workload Identity Pool must have a ca_pool
9691 # configured in the same region.
9692 #
9693 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
9694 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
9695 # balancer sends this string as the SNI hostname in the TLS connection to
9696 # the backend, and requires that this string match a Subject Alternative
9697 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
9698 # NEG backend, if the SNI is specified here, the load balancer uses it
9699 # regardless of whether the Regional Internet NEG is specified with FQDN or
9700 # IP address and port. When both sni and subjectAltNames[] are specified,
9701 # the load balancer matches the backend certificate&#x27;s SAN only to
9702 # subjectAltNames[].
9703 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
9704 # verifies during a TLS handshake with the backend. When the server
9705 # presents its X.509 certificate to the Load Balancer, the Load Balancer
9706 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
9707 # match one of the subjectAltNames in the list. This field is limited to 5
9708 # entries. When both sni and subjectAltNames[] are specified, the load
9709 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
9710 { # A Subject Alternative Name that the load balancer matches against the SAN
9711 # field in the TLS certificate provided by the backend, specified as either
9712 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
9713 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
9714 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
9715 },
9716 ],
9717 },
9718 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
9719 {
9720 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
9721 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
9722 # and ForwardingRule.
9723 },
9724 ],
9725 },
9726 ],
9727 &quot;kind&quot;: &quot;compute#usableBackendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend
9728 # services.
9729 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
9730 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
9731 # the query parameter pageToken in the next list request.
9732 # Subsequent list requests will have their own nextPageToken to
9733 # continue paging through the results.
9734 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
9735 &quot;warning&quot;: { # [Output Only] Informational warning message.
9736 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9737 # Engine returns NO_RESULTS_ON_PAGE if there
9738 # are no results in the response.
9739 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9740 # value format. For example:
9741 #
9742 # &quot;data&quot;: [
9743 # {
9744 # &quot;key&quot;: &quot;scope&quot;,
9745 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9746 # }
9747 {
9748 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9749 # returned. For example, for warnings where there are no results in a list
9750 # request for a particular zone, this key might be scope and
9751 # the key value might be the zone name. Other examples might be a key
9752 # indicating a deprecated resource and a suggested replacement, or a
9753 # warning about invalid network settings (for example, if an instance
9754 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9755 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9756 },
9757 ],
9758 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9759 },
9760 }</pre>
9761 </div>
9762
9763 <div class="method">
9764 <code class="details" id="listUsable_next">listUsable_next()</code>
9765 <pre>Retrieves the next page of results.
9766
9767 Args:
9768 previous_request: The request for the previous page. (required)
9769 previous_response: The response from the request for the previous page. (required)
9770
9771 Returns:
9772 A request object that you can call &#x27;execute()&#x27; on to request the next
9773 page. Returns None if there are no more items in the collection.
9774 </pre>
9775 </div>
9776
9777 <div class="method">
9778 <code class="details" id="list_next">list_next()</code>
9779 <pre>Retrieves the next page of results.
9780
9781 Args:
9782 previous_request: The request for the previous page. (required)
9783 previous_response: The response from the request for the previous page. (required)
9784
9785 Returns:
9786 A request object that you can call &#x27;execute()&#x27; on to request the next
9787 page. Returns None if there are no more items in the collection.
9788 </pre>
9789 </div>
9790
9791 <div class="method">
9792 <code class="details" id="patch">patch(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
9793 <pre>Patches the specified BackendService resource with the data included in the
9794 request. For more information, see
9795 Backend services overview. This method
9796 supports PATCH semantics and uses the JSON merge
9797 patch format and processing rules.
9798
9799 Args:
9800 project: string, Project ID for this request. (required)
9801 backendService: string, Name of the BackendService resource to patch. (required)
9802 body: object, The request body.
9803 The object takes the form of:
9804
9805 { # Represents a Backend Service resource.
9806 #
9807 # A backend service defines how Google Cloud load balancers distribute traffic.
9808 # The backend service configuration contains a set of values, such as the
9809 # protocol used to connect to backends, various distribution and session
9810 # settings, health checks, and timeouts. These settings provide fine-grained
9811 # control over how your load balancer behaves. Most of the settings have
9812 # default values that allow for easy configuration if you need to get started
9813 # quickly.
9814 #
9815 # Backend services in Google Compute Engine can be either regionally or
9816 # globally scoped.
9817 #
9818 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
9819 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
9820 #
9821 # For more information, seeBackend
9822 # Services.
9823 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
9824 # Load Balancers and Traffic Director and requires
9825 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
9826 #
9827 # If set to 0, the cookie is non-persistent and lasts only until
9828 # the end of the browser session (or equivalent). The maximum allowed value
9829 # is two weeks (1,209,600).
9830 #
9831 # Not supported when the backend service is referenced by a URL map that is
9832 # bound to target gRPC proxy that has validateForProxyless field set to true.
9833 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
9834 { # Message containing information of one individual backend.
9835 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
9836 # handle additional traffic or is fully loaded. For usage guidelines, see
9837 # Connection balancing mode.
9838 #
9839 # Backends must use compatible balancing modes. For more information, see
9840 # Supported balancing modes and target capacity settings and
9841 # Restrictions and guidance for instance groups.
9842 #
9843 # Note: Currently, if you use the API to configure incompatible balancing
9844 # modes, the configuration might be accepted even though it has no impact
9845 # and is ignored. Specifically, Backend.maxUtilization is ignored when
9846 # Backend.balancingMode is RATE. In the future, this incompatible combination
9847 # will be rejected.
9848 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
9849 # mode.
9850 # The default value is 1, which means the group serves up to
9851 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
9852 # completely drained, offering 0% of its available capacity. The valid ranges
9853 # are 0.0 and [0.1,1.0].
9854 # You cannot configure a setting larger than 0 and smaller than0.1.
9855 # You cannot configure a setting of 0 when there is only one
9856 # backend attached to the backend service.
9857 #
9858 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
9859 # internet NEGs, regional serverless NEGs, and PSC NEGs.
9860 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
9861 # BalancingMode.
9862 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
9863 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
9864 # Monitoring, but is not used for load balancing.
9865 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
9866 # balancing mode. The valid range is [0.0, 1.0].
9867 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
9868 # long and match the regular expression
9869 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
9870 # first character must be a lowercase letter, and all following
9871 # characters must be a dash, period, underscore, lowercase letter, or
9872 # digit, except the last character, which cannot be a dash, period, or
9873 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
9874 # field can only be used for a global or regional backend service with the
9875 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
9876 },
9877 ],
9878 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9879 # create the resource.
9880 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
9881 # failover backend can be configured for a given BackendService.
9882 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
9883 # group or network endpoint
9884 # group (NEG) resource. To determine what types of backends a load
9885 # balancer supports, see the [Backend services
9886 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
9887 #
9888 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
9889 # or NEG. Partial URLs are not supported.
9890 #
9891 # If haPolicy is specified, backends must refer to NEG resources of type
9892 # GCE_VM_IP.
9893 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
9894 # guidelines, seeConnection
9895 # balancing mode and Utilization
9896 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
9897 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
9898 # guidelines, seeConnection
9899 # balancing mode and Utilization
9900 # balancing mode.
9901 #
9902 # Not available if the backend&#x27;s balancingMode isRATE.
9903 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
9904 # For usage guidelines, seeConnection
9905 # balancing mode and Utilization
9906 # balancing mode.
9907 #
9908 # Not available if the backend&#x27;s balancingMode isRATE.
9909 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
9910 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
9911 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
9912 # Not available if backend&#x27;s balancingMode is RATE
9913 # or CONNECTION.
9914 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
9915 # Not available if backend&#x27;s balancingMode is RATE
9916 # or CONNECTION.
9917 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
9918 # usage guidelines, seeRate
9919 # balancing mode and Utilization
9920 # balancing mode.
9921 #
9922 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9923 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
9924 # guidelines, seeRate
9925 # balancing mode and Utilization
9926 # balancing mode.
9927 #
9928 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9929 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
9930 # guidelines, seeRate
9931 # balancing mode and Utilization
9932 # balancing mode.
9933 #
9934 # Not available if the backend&#x27;s balancingMode isCONNECTION.
9935 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
9936 #
9937 # For usage guidelines, seeUtilization
9938 # balancing mode.
9939 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
9940 # the backend.
9941 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
9942 },
9943 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
9944 # sending traffic to backends with default preference. The possible values
9945 # are:
9946 #
9947 # - PREFERRED: Backends with this preference level will be
9948 # filled up to their capacity limits first, based on RTT.
9949 # - DEFAULT: If preferred backends don&#x27;t have enough
9950 # capacity, backends in this layer would be used and traffic would be
9951 # assigned based on the load balancing algorithm you use. This is the
9952 # default
9953 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
9954 # Attachment).
9955 # e.g.
9956 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
9957 # for Cloud Run service.
9958 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
9959 # for PSC Service Attachment.
9960 &quot;trafficDuration&quot;: &quot;A String&quot;,
9961 },
9962 ],
9963 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
9964 # specified load balancer types.
9965 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
9966 # Pragma or Authorization headers. Up to 5 headers can be specified.
9967 # The cache is bypassed for all cdnPolicy.cacheMode settings.
9968 { # Bypass the cache when the specified request headers are present,
9969 # e.g. Pragma or Authorization headers. Values are case insensitive.
9970 # The presence of such a header overrides the cache_mode setting.
9971 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
9972 # Values are case-insensitive.
9973 },
9974 ],
9975 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
9976 # CDN.
9977 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
9978 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
9979 &quot;A String&quot;,
9980 ],
9981 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
9982 # The name=value pair will be used in the cache key Cloud CDN generates.
9983 &quot;A String&quot;,
9984 ],
9985 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
9986 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
9987 # query_string_whitelist and query_string_blacklist. If neither is set, the
9988 # entire query string will be included. If false, the query string will be
9989 # excluded from the cache key entirely.
9990 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
9991 # parameters will be included. Either specify query_string_whitelist or
9992 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
9993 # not treated as delimiters.
9994 &quot;A String&quot;,
9995 ],
9996 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
9997 # parameters will be excluded. Either specify query_string_whitelist or
9998 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
9999 # not treated as delimiters.
10000 &quot;A String&quot;,
10001 ],
10002 },
10003 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
10004 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
10005 # headers to cache content. Responses without these headers will not be
10006 # cached at Google&#x27;s edge, and will require a full trip to the origin on
10007 # every request, potentially impacting performance and increasing load on
10008 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
10009 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
10010 # Warning: this may result in Cloud CDN caching private,
10011 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
10012 # including common image formats, media (video and audio), and web assets
10013 # (JavaScript and CSS). Requests and responses that are marked as
10014 # uncacheable, as well as dynamic content (including HTML), will not be
10015 # cached.
10016 #
10017 # If no value is provided for cdnPolicy.cacheMode, it defaults
10018 # to CACHE_ALL_STATIC.
10019 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
10020 # used to clamp the max-age (or Expires) value sent to the client. With
10021 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
10022 # response max-age directive, along with a &quot;public&quot; directive. For
10023 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
10024 # from the origin (if specified), or else sets the response max-age
10025 # directive to the lesser of the client_ttl and default_ttl, and also
10026 # ensures a &quot;public&quot; cache-control directive is present.
10027 # If a client TTL is not specified, a default value (1 hour) will be used.
10028 # The maximum allowed value is 31,622,400s (1 year).
10029 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
10030 # responses that do not have an existing valid TTL (max-age or s-maxage).
10031 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
10032 # The value of defaultTTL cannot be set to a value greater than that of
10033 # maxTTL, but can be equal.
10034 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
10035 # will overwrite the TTL set in all responses. The maximum allowed value is
10036 # 31,622,400s (1 year), noting that infrequently accessed objects may be
10037 # evicted from the cache before the defined TTL.
10038 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
10039 # origin.
10040 # Cache directives that attempt to set a max-age or s-maxage higher than
10041 # this, or an Expires header more than maxTTL seconds in the future will
10042 # be capped at the value of maxTTL, as if it were the value of an
10043 # s-maxage Cache-Control directive.
10044 # Headers sent to the client will not be modified.
10045 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
10046 # The maximum allowed value is 31,622,400s (1 year), noting that
10047 # infrequently accessed objects may be evicted from the cache before
10048 # the defined TTL.
10049 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
10050 # to apply fine-grained caching for common errors or redirects.
10051 # This can reduce the load on your origin and improve end-user
10052 # experience by reducing response latency.
10053 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
10054 # negative caching applies to responses with the specified response code
10055 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
10056 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
10057 # to all responses with the specified response code, and override any
10058 # caching headers.
10059 # By default, Cloud CDN will apply the following default TTLs to these
10060 # status codes:
10061 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
10062 # HTTP 404 (Not Found), 410 (Gone),
10063 # 451 (Unavailable For Legal Reasons): 120s
10064 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
10065 # These defaults can be overridden in negative_caching_policy.
10066 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
10067 # negative_caching must be enabled to configure negative_caching_policy.
10068 # Omitting the policy and leaving negative_caching enabled will use
10069 # Cloud CDN&#x27;s default cache TTLs.
10070 # Note that when specifying an explicit negative_caching_policy, you
10071 # should take care to specify a cache TTL for all response codes
10072 # that you wish to cache. Cloud CDN will not apply any default
10073 # negative caching when a policy exists.
10074 { # Specify CDN TTLs for response error codes.
10075 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
10076 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
10077 # specified as values, and you cannot specify a status code more than
10078 # once.
10079 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
10080 # corresponding status code.
10081 # The maximum allowed value is 1800s (30 minutes), noting that
10082 # infrequently accessed objects may be evicted from the cache before the
10083 # defined TTL.
10084 },
10085 ],
10086 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
10087 # requests into a small number of requests to the origin.
10088 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
10089 # content with the origin, or when an error is encountered when refreshing
10090 # the cache.
10091 # This setting defines the default &quot;max-stale&quot; duration for any cached
10092 # responses that do not specify a max-stale directive. Stale responses that
10093 # exceed the TTL configured here will not be served. The default limit
10094 # (max-stale) is 86400s (1 day), which will allow stale content to be
10095 # served up to this limit beyond the max-age (or s-maxage) of a cached
10096 # response.
10097 # The maximum allowed value is 604800 (1 week).
10098 # Set this to zero (0) to disable serve-while-stale.
10099 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
10100 # considered fresh. After this time period, the response will be
10101 # revalidated before being served. Defaults to 1hr (3600s). When serving
10102 # responses to signed URL requests, Cloud CDN will internally behave as
10103 # though all responses from this backend had a &quot;Cache-Control:
10104 # public, max-age=[TTL]&quot; header, regardless of any existing
10105 # Cache-Control header. The actual headers served in responses will not be
10106 # altered.
10107 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
10108 &quot;A String&quot;,
10109 ],
10110 },
10111 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
10112 # backend service.
10113 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
10114 # as a count of seconds and fractions of seconds at nanosecond
10115 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10116 # or &quot;month&quot;. Range is approximately 10,000 years.
10117 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10118 # Durations less than one second are represented with a 0
10119 # `seconds` field and a positive `nanos` field. Must be from 0
10120 # to 999,999,999 inclusive.
10121 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10122 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10123 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10124 },
10125 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
10126 # there is no limit.
10127 #
10128 # Not supported when the backend service is referenced by a URL map that is
10129 # bound to target gRPC proxy that has validateForProxyless field set to true.
10130 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
10131 # not specified, there is no limit.
10132 #
10133 # Not supported when the backend service is referenced by a URL map that is
10134 # bound to target gRPC proxy that has validateForProxyless field set to true.
10135 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
10136 # service. If not specified, there is no limit.
10137 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
10138 # This parameter is respected by both the HTTP/1.1 and HTTP/2
10139 # implementations. If not specified, there is no limit. Setting this
10140 # parameter to 1 will effectively disable keep alive.
10141 #
10142 # Not supported when the backend service is referenced by a URL map that is
10143 # bound to target gRPC proxy that has validateForProxyless field set to true.
10144 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
10145 # not specified, the default is 1.
10146 #
10147 # Not supported when the backend service is referenced by a URL map that is
10148 # bound to target gRPC proxy that has validateForProxyless field set to true.
10149 },
10150 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
10151 # the client&#x27;s Accept-Encoding header.
10152 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
10153 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
10154 # instance. For supported load balancers and protocols, as described inEnabling
10155 # connection draining.
10156 },
10157 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
10158 # tracking policy settings are only available for external passthrough
10159 # Network Load Balancers and internal passthrough Network Load Balancers.
10160 #
10161 # connectionTrackingPolicy cannot be specified with haPolicy.
10162 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
10163 # value is DEFAULT_FOR_PROTOCOL.
10164 #
10165 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
10166 # persist on unhealthy backends only for connection-oriented protocols
10167 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
10168 # Affinity is configured for 5-tuple. They do not persist forUDP.
10169 #
10170 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
10171 # the existing connections on the unhealthy backend are never persisted on
10172 # the unhealthy backend. They are always diverted to newly selected healthy
10173 # backends (unless all backends are unhealthy).
10174 #
10175 # If set to ALWAYS_PERSIST, existing connections always
10176 # persist on unhealthy backends regardless of protocol and session
10177 # affinity. It is generally not recommended to use this mode overriding the
10178 # default.
10179 #
10180 # For more details, see [Connection Persistence for Network Load
10181 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
10182 # and [Connection Persistence for Internal TCP/UDP Load
10183 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
10184 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
10185 # Balancers. This option is not available publicly.
10186 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
10187 # matching traffic (in seconds).
10188 #
10189 # For internal passthrough Network Load Balancers:
10190 #
10191 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
10192 # - It can be set only if Connection Tracking is less than 5-tuple
10193 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
10194 # Mode is PER_SESSION).
10195 #
10196 #
10197 #
10198 # For external passthrough Network Load Balancers the default is 60
10199 # seconds. This option is not available publicly.
10200 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
10201 # options:
10202 #
10203 # - PER_CONNECTION: This is the default mode. The Connection
10204 # Tracking is performed as per the Connection Key (default Hash Method) for
10205 # the specific protocol.
10206 # - PER_SESSION: The Connection Tracking is performed as per
10207 # the configured Session Affinity. It matches the configured Session
10208 # Affinity.
10209 #
10210 #
10211 #
10212 # For more details, see [Tracking Mode for Network Load
10213 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
10214 # and [Tracking Mode for Internal TCP/UDP Load
10215 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
10216 },
10217 &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
10218 # affinity based on HTTP headers, cookies or other properties. This load
10219 # balancing policy is applicable only for HTTP connections. The affinity to a
10220 # particular destination host will be lost when one or more hosts are
10221 # added/removed from the destination service. This field specifies parameters
10222 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
10223 #
10224 # This field is applicable to either:
10225 #
10226 # - A regional backend service with the service protocol set to HTTP,
10227 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10228 # INTERNAL_MANAGED.
10229 # - A global backend service with the
10230 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
10231 &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
10232 # be used as the hash key for the consistent hash load balancer. If the
10233 # cookie is not present, it will be generated. This field is applicable if
10234 # the sessionAffinity is set to HTTP_COOKIE.
10235 #
10236 # Not supported when the backend service is referenced by a URL map that is
10237 # bound to target gRPC proxy that has validateForProxyless field set to true.
10238 # for load balancing policies that use a consistent hash.
10239 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
10240 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
10241 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
10242 # as a count of seconds and fractions of seconds at nanosecond
10243 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10244 # or &quot;month&quot;. Range is approximately 10,000 years.
10245 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10246 # Durations less than one second are represented with a 0
10247 # `seconds` field and a positive `nanos` field. Must be from 0
10248 # to 999,999,999 inclusive.
10249 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10250 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10251 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10252 },
10253 },
10254 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
10255 # applicable if the sessionAffinity is set toHEADER_FIELD.
10256 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
10257 # 1024. Larger ring sizes result in more granular load distributions. If the
10258 # number of hosts in the load balancing pool is larger than the ring size,
10259 # each host will be assigned a single virtual node.
10260 },
10261 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
10262 # text format.
10263 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
10264 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
10265 # locality_lb_policy.
10266 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
10267 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
10268 # long and match the regular expression
10269 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
10270 # first character must be a lowercase letter, and all following
10271 # characters must be a dash, period, underscore, lowercase letter, or
10272 # digit, except the last character, which cannot be a dash, period, or
10273 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
10274 # field can only be used for a global or regional backend service with the
10275 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
10276 },
10277 ],
10278 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
10279 # custom
10280 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
10281 &quot;A String&quot;,
10282 ],
10283 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
10284 # custom
10285 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
10286 &quot;A String&quot;,
10287 ],
10288 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
10289 # create the resource.
10290 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
10291 # backend service with dynamic forwarding feature which together with Service
10292 # Extension allows customized and complex routing logic.
10293 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
10294 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
10295 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
10296 },
10297 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
10298 # service. Some ranges are restricted: Restricted
10299 # ranges.
10300 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
10301 },
10302 },
10303 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
10304 # this backend service.
10305 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
10306 # global external Application Load Balancer.
10307 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
10308 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
10309 #
10310 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
10311 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
10312 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
10313 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
10314 # externalManagedMigrationTestingPercentage.
10315 #
10316 # Rolling back a migration requires the states to be set in reverse order. So
10317 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
10318 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
10319 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
10320 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
10321 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
10322 # external Application Load Balancer.
10323 #
10324 # The value of this field must be in the range [0, 100].
10325 #
10326 # Session affinity options will slightly affect this routing behavior, for
10327 # more details, see:Session
10328 # Affinity.
10329 #
10330 # This value can only be set if the loadBalancingScheme in the BackendService
10331 # is set to EXTERNAL (when using the classic Application Load Balancer) and
10332 # the migration state is TEST_BY_PERCENTAGE.
10333 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
10334 # as a backup (failover) backend.
10335 # For load balancers that have configurable failover:
10336 # [Internal passthrough Network Load
10337 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10338 # and [external passthrough Network Load
10339 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10340 #
10341 # failoverPolicy cannot be specified with haPolicy.
10342 # failover:
10343 # [Internal passthrough Network Load
10344 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10345 # and [external passthrough
10346 # Network Load
10347 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10348 # On failover or failback, this field indicates whether connection draining
10349 # will be honored. Google Cloud has a fixed connection draining timeout of
10350 # 10 minutes. A setting of true terminates existing TCP
10351 # connections to the active pool during failover and failback, immediately
10352 # draining traffic. A setting of false allows existing TCP
10353 # connections to persist, even on VMs no longer in the active pool, for up
10354 # to the duration of the connection draining timeout (10 minutes).
10355 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
10356 #
10357 # The default is false.
10358 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
10359 # load balancer are dropped when all primary and all backup backend VMs are
10360 # unhealthy.If set to false, connections are distributed
10361 # among all primary VMs when all primary and all backup backend VMs are
10362 # unhealthy.
10363 # For load balancers that have configurable
10364 # failover:
10365 # [Internal passthrough
10366 # Network Load
10367 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10368 # and [external passthrough
10369 # Network Load
10370 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10371 # The default is false.
10372 &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
10373 # failover when the number of healthy primary VMs equals zero.
10374 # For all other values, the load balancer performs a failover when the
10375 # total number of healthy primary VMs is less than this ratio.
10376 # For load balancers that have configurable
10377 # failover:
10378 # [Internal TCP/UDP Load
10379 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
10380 # and [external TCP/UDP Load
10381 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
10382 },
10383 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
10384 # This field is used in optimistic locking. This field will be ignored when
10385 # inserting a BackendService. An up-to-date fingerprint must be provided in
10386 # order to update the BackendService, otherwise the request will
10387 # fail with error 412 conditionNotMet.
10388 #
10389 # To see the latest fingerprint, make a get() request to
10390 # retrieve a BackendService.
10391 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
10392 # Protocol Forwarding.
10393 #
10394 # The backends of this regional backend service must only specify zonal
10395 # network endpoint groups (NEGs) of type GCE_VM_IP.
10396 #
10397 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
10398 # regional backend service must set the network field. All zonal NEGs must
10399 # belong to the same network. However, individual NEGs can
10400 # belong to different subnetworks of that network.
10401 #
10402 # When haPolicy is specified, the set of attached network endpoints across
10403 # all backends comprise an High Availability domain from which one endpoint
10404 # is selected as the active endpoint (the leader) that receives all
10405 # traffic.
10406 #
10407 # haPolicy can be added only at backend service creation time. Once set up,
10408 # it cannot be deleted.
10409 #
10410 # Note that haPolicy is not for load balancing, and therefore cannot be
10411 # specified with sessionAffinity, connectionTrackingPolicy, and
10412 # failoverPolicy.
10413 #
10414 # haPolicy requires customers to be responsible for tracking backend
10415 # endpoint health and electing a leader among the healthy endpoints.
10416 # Therefore, haPolicy cannot be specified with healthChecks.
10417 #
10418 # haPolicy can only be specified for External Passthrough Network Load
10419 # Balancers and Internal Passthrough Network Load Balancers.
10420 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
10421 # achieve it.
10422 #
10423 # Supported values are:
10424 #
10425 # - DISABLED: Fast IP Move is disabled. You can only use the
10426 # haPolicy.leader API to update the leader.
10427 # - &gt;GARP_RA: Provides a method to very quickly define a new network
10428 # endpoint as the leader. This method is faster than updating the leader
10429 # using the haPolicy.leader API. Fast IP move works as follows: The VM
10430 # hosting the network endpoint that should become the new leader sends
10431 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
10432 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
10433 # temporarily associates the forwarding rule IP address with that VM, and
10434 # both new and in-flight packets are quickly delivered to that VM.
10435 #
10436 #
10437 #
10438 # Note the important properties of the Fast IP Move functionality:
10439 #
10440 # - The GARP/RA-initiated re-routing stays active for approximately 20
10441 # minutes. After triggering fast failover, you must also
10442 # appropriately set the haPolicy.leader.
10443 # - The new leader instance should continue to send GARP/RA packets
10444 # periodically every 10 seconds until at least 10 minutes after updating
10445 # the haPolicy.leader (but stop immediately if it is no longer the leader).
10446 # - After triggering a fast failover, we recommend that you wait at least
10447 # 3 seconds before sending another GARP/RA packet from a different VM
10448 # instance to avoid race conditions.
10449 # - Don&#x27;t send GARP/RA packets from different VM
10450 # instances at the same time. If multiple instances continue to send
10451 # GARP/RA packets, traffic might be routed to different destinations in an
10452 # alternating order. This condition ceases when a single instance
10453 # issues a GARP/RA packet.
10454 # - The GARP/RA request always takes priority over the leader API.
10455 # Using the haPolicy.leader API to change the leader to a different
10456 # instance will have no effect until the GARP/RA request becomes
10457 # inactive.
10458 # - The GARP/RA packets should follow the GARP/RA
10459 # Packet Specifications..
10460 # - When multiple forwarding rules refer to a regional backend service,
10461 # you need only send a GARP or RA packet for a single forwarding rule
10462 # virtual IP. The virtual IPs for all forwarding rules targeting the same
10463 # backend service will also be moved to the sender of the GARP or RA
10464 # packet.
10465 #
10466 #
10467 #
10468 # The following are the Fast IP Move limitations (that is, when fastIPMove
10469 # is not DISABLED):
10470 #
10471 # - Multiple forwarding rules cannot use the same IP address if one of
10472 # them refers to a regional backend service with fastIPMove.
10473 # - The regional backend service must set the network field, and all
10474 # NEGs must belong to that network. However, individual
10475 # NEGs can belong to different subnetworks of that network.
10476 # - The maximum number of network endpoints across all backends of a
10477 # backend service with fastIPMove is 32.
10478 # - The maximum number of backend services with fastIPMove that can have
10479 # the same network endpoint attached to one of its backends is 64.
10480 # - The maximum number of backend services with fastIPMove in a VPC in a
10481 # region is 64.
10482 # - The network endpoints that are attached to a backend of a backend
10483 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
10484 # - Traffic directed to the leader by a static route next hop will not be
10485 # redirected to a new leader by fast failover. Such traffic will only be
10486 # redirected once an haPolicy.leader update has taken effect. Only traffic
10487 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
10488 # fast failover.
10489 #
10490 #
10491 # haPolicy.fastIPMove can be set only at backend service creation time.
10492 # Once set, it cannot be updated.
10493 #
10494 # By default, fastIpMove is set to DISABLED.
10495 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
10496 # this service as the active endpoint (the leader) that receives all
10497 # traffic.
10498 #
10499 # When the leader changes, there is no connection draining to persist
10500 # existing connections on the old leader.
10501 #
10502 # You are responsible for selecting a suitable endpoint as the
10503 # leader. For example, preferring a healthy endpoint over unhealthy ones.
10504 # Note that this service does not track backend endpoint health, and
10505 # selects the configured leader unconditionally.
10506 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
10507 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
10508 # that the leader is attached to.
10509 #
10510 # The leader&#x27;s backendGroup must already be specified as a backend of
10511 # this backend service. Removing a backend that is designated as the
10512 # leader&#x27;s backendGroup is not permitted.
10513 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
10514 # designated as the leader.
10515 #
10516 # This network endpoint cannot be detached from the NEG specified in
10517 # the haPolicy.leader.backendGroup until the leader is updated with
10518 # another network endpoint, or the leader is removed from the haPolicy.
10519 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
10520 # instance must already be attached to the NEG specified in the
10521 # haPolicy.leader.backendGroup.
10522 #
10523 # The name must be 1-63 characters long, and comply with RFC1035.
10524 # Authorization requires the following IAM permission on the
10525 # specified resource instance: compute.instances.use
10526 },
10527 },
10528 },
10529 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
10530 # httpsHealthChecks (legacy) resource for health checking this backend
10531 # service. Not all backend services support legacy health checks. See
10532 # Load balancer guide. Currently, at most one health check can be
10533 # specified for each backend service. Backend services with
10534 # instance group or zonal NEG backends must have a health check unless
10535 # haPolicy is specified. Backend services with internet or serverless NEG
10536 # backends must not have a health check.
10537 #
10538 # healthChecks[] cannot be specified with haPolicy.
10539 &quot;A String&quot;,
10540 ],
10541 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
10542 # Not available for internal passthrough Network Load Balancers and external
10543 # passthrough Network Load Balancers.
10544 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
10545 # incoming requests.
10546 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
10547 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
10548 # For security reasons, this value cannot be retrieved via the API.
10549 # Instead, the SHA-256 hash of the value is returned in the
10550 # oauth2ClientSecretSha256 field.
10551 #
10552 # @InputOnly
10553 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
10554 },
10555 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
10556 # defined by the server.
10557 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
10558 # from the client to the backend for proxyless gRPC).
10559 # The possible values are:
10560 #
10561 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
10562 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10563 # Group), regardless of traffic from the client to the proxy. Only IPv4
10564 # health checks are used to check the health of the backends. This is the
10565 # default setting.
10566 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
10567 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
10568 # address).
10569 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
10570 # backend service (Instance Group, Managed Instance Group, Network Endpoint
10571 # Group), regardless of traffic from the client to the proxy. Only IPv6
10572 # health checks are used to check the health of the backends.
10573 #
10574 #
10575 #
10576 # This field is applicable to either:
10577 #
10578 # - Advanced global external Application Load Balancer (load balancing
10579 # scheme EXTERNAL_MANAGED),
10580 # - Regional external Application Load
10581 # Balancer,
10582 # - Internal proxy Network Load Balancer (load balancing
10583 # scheme INTERNAL_MANAGED),
10584 # - Regional internal Application Load
10585 # Balancer (load balancing scheme INTERNAL_MANAGED),
10586 # - Traffic
10587 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
10588 # INTERNAL_SELF_MANAGED).
10589 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
10590 # for backend services.
10591 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
10592 # created for one type of load balancer cannot be used with another.
10593 # For more information, refer toChoosing
10594 # a load balancer.
10595 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
10596 # preference. When you use localityLbPolicies, you must set at least one
10597 # value for either the localityLbPolicies[].policy or the
10598 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
10599 # value set in the localityLbPolicy field.
10600 #
10601 # For an example of how to use this field, seeDefine
10602 # a list of preferred policies.
10603 #
10604 # Caution: This field and its children are intended for use in a service mesh
10605 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
10606 # that have this configuration.
10607 { # Container for either a built-in LB policy supported by gRPC or Envoy or
10608 # a custom one implemented by the end user.
10609 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
10610 # deployed with the client.
10611 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
10612 # by a locally installed custom policy implementation.
10613 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
10614 #
10615 # The value should match the name of a custom implementation registered
10616 # on the gRPC clients. It should follow protocol buffer message naming
10617 # conventions and include the full path (for example,
10618 # myorg.CustomLbPolicy). The maximum length is 256 characters.
10619 #
10620 # Do not specify the same custom policy more than once for a
10621 # backend. If you do, the configuration is rejected.
10622 #
10623 # For an example of how to use this field, seeUse
10624 # a custom policy.
10625 },
10626 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
10627 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
10628 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
10629 # about these values, see the description of localityLbPolicy.
10630 #
10631 # Do not specify the same policy more than once for a
10632 # backend. If you do, the configuration is rejected.
10633 },
10634 },
10635 ],
10636 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
10637 # possible values are:
10638 #
10639 # - ROUND_ROBIN: This is a simple policy in which each healthy
10640 # backend is selected in round robin order. This is the default.
10641 # - LEAST_REQUEST: An O(1) algorithm which
10642 # selects two random healthy hosts and picks the host which has fewer active
10643 # requests.
10644 # - RING_HASH: The ring/modulo hash load balancer implements
10645 # consistent hashing to backends. The algorithm has the property that the
10646 # addition/removal of a host from a set of N hosts only affects 1/N of the
10647 # requests.
10648 # - RANDOM: The load balancer selects a random healthy
10649 # host.
10650 # - ORIGINAL_DESTINATION: Backend host is selected
10651 # based on the client connection metadata, i.e., connections are opened to
10652 # the same address as the destination address of the incoming connection
10653 # before the connection was redirected to the load balancer.
10654 # - MAGLEV: used as a drop in replacement for the ring hash
10655 # load balancer. Maglev is not as stable as ring hash but has faster table
10656 # lookup build times and host selection times. For more information about
10657 # Maglev, see Maglev:
10658 # A Fast and Reliable Software Network Load Balancer.
10659 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
10660 # Load Balancing using weights computed from Backend reported Custom Metrics.
10661 # If set, the Backend Service responses are expected to contain non-standard
10662 # HTTP response header field Endpoint-Load-Metrics. The reported
10663 # metrics to use for computing the weights are specified via thecustomMetrics field.
10664 #
10665 # This field is applicable to either:
10666 # - A regional backend service with the service protocol set to HTTP,
10667 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
10668 # INTERNAL_MANAGED.
10669 # - A global backend service with the
10670 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
10671 # EXTERNAL_MANAGED.
10672 #
10673 #
10674 # If sessionAffinity is not configured—that is, if session
10675 # affinity remains at the default value of NONE—then the
10676 # default value for localityLbPolicy
10677 # is ROUND_ROBIN. If session affinity is set to a value other
10678 # than NONE,
10679 # then the default value for localityLbPolicy isMAGLEV.
10680 #
10681 # Only ROUND_ROBIN and RING_HASH are supported
10682 # when the backend service is referenced by a URL map that is bound to
10683 # target gRPC proxy that has validateForProxyless field set to true.
10684 #
10685 # localityLbPolicy cannot be specified with haPolicy.
10686 &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
10687 # by this backend service. If logging is enabled, logs will be exported to
10688 # Stackdriver.
10689 # backend service.
10690 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
10691 # traffic served by this backend service. The default value is false.
10692 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
10693 { # Determines which HTTP headers will be logged to Stackdriver.
10694 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10695 },
10696 ],
10697 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
10698 { # Determines which HTTP headers will be logged to Stackdriver.
10699 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
10700 },
10701 ],
10702 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
10703 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
10704 # of optional fields you want to include in the logs. For example:
10705 # serverInstance, serverGkeDetails.cluster,
10706 # serverGkeDetails.pod.podNamespace
10707 &quot;A String&quot;,
10708 ],
10709 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
10710 # service. Configures whether all, none or a subset of optional fields
10711 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
10712 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
10713 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
10714 # service. The value of the field must be in [0, 1]. This configures the
10715 # sampling rate of requests to the load balancer where 1.0 means all logged
10716 # requests are reported and 0.0 means no logged requests are reported. The
10717 # default value is 1.0.
10718 },
10719 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
10720 # service. Duration is computed from the beginning of the stream until the
10721 # response has been completely processed, including all retries. A stream
10722 # that does not complete in this duration is closed.
10723 #
10724 # If not specified, there will be no timeout limit, i.e. the maximum
10725 # duration is infinite.
10726 #
10727 # This value can be overridden in the PathMatcher configuration of the
10728 # UrlMap that references this backend service.
10729 #
10730 # This field is only allowed when the loadBalancingScheme of
10731 # the backend service is INTERNAL_SELF_MANAGED.
10732 # as a count of seconds and fractions of seconds at nanosecond
10733 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10734 # or &quot;month&quot;. Range is approximately 10,000 years.
10735 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10736 # Durations less than one second are represented with a 0
10737 # `seconds` field and a positive `nanos` field. Must be from 0
10738 # to 999,999,999 inclusive.
10739 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10740 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10741 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10742 },
10743 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
10744 # controller and read by the backend RCTH
10745 &quot;a_key&quot;: &quot;A String&quot;,
10746 },
10747 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
10748 # The name must be 1-63 characters long, and comply withRFC1035.
10749 # Specifically, the name must be 1-63 characters long and match the regular
10750 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10751 # character must be a lowercase letter, and all following characters must
10752 # be a dash, lowercase letter, or digit, except the last character, which
10753 # cannot be a dash.
10754 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
10755 #
10756 # This field must be set for Internal Passthrough Network Load Balancers when
10757 # the haPolicy is enabled, and for External Passthrough Network Load
10758 # Balancers when the haPolicy fastIpMove is enabled.
10759 #
10760 # 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.
10761 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
10762 # Load Balancers.
10763 #
10764 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
10765 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
10766 # endpoints in the local zone.
10767 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
10768 # possible values are:
10769 #
10770 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
10771 # is disabled. The load balancer distributes new connections to all
10772 # healthy backend endpoints across all zones.
10773 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
10774 # enabled. The load balancer distributes new connections to all healthy
10775 # backend endpoints in the local zone only. If there are no healthy
10776 # backend endpoints in the local zone, the load balancer distributes
10777 # new connections to all backend endpoints in the local zone.
10778 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
10779 # enabled. The load balancer distributes new connections to all healthy
10780 # backend endpoints in the local zone only. If there aren&#x27;t enough
10781 # healthy backend endpoints in the local zone, the load balancer
10782 # distributes new connections to all healthy backend endpoints across all
10783 # zones.
10784 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
10785 # of healthy backend endpoints in a zone to the count of backend
10786 # endpoints in that same zone is equal to or above this threshold, the
10787 # load balancer distributes new connections to all healthy endpoints in
10788 # the local zone only. When the ratio of the count of healthy backend
10789 # endpoints in a zone to the count of backend endpoints in that same
10790 # zone is below this threshold, the load balancer distributes all new
10791 # connections to all healthy endpoints across all zones.
10792 },
10793 },
10794 &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.
10795 # the backend service.
10796 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
10797 # service.
10798 },
10799 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
10800 # load balancing pool of each individual proxy instance that processes the
10801 # traffic for the given backend service. If not set, this feature is
10802 # considered disabled.
10803 #
10804 # Results of the outlier detection algorithm (ejection of endpoints from the
10805 # load balancing pool and returning them back to the pool) are executed
10806 # independently by each proxy instance of the load balancer. In most cases,
10807 # more than one proxy instance handles the traffic received by a backend
10808 # service. Thus, it is possible that an unhealthy endpoint is detected and
10809 # ejected by only some of the proxies, and while this happens, other proxies
10810 # may continue to send requests to the same unhealthy endpoint until they
10811 # detect and eject the unhealthy endpoint.
10812 #
10813 # Applicable backend endpoints can be:
10814 #
10815 # - VM instances in an Instance Group
10816 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
10817 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
10818 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
10819 # Functions Services
10820 # - Private Service Connect NEGs, that resolve to
10821 # Google-managed regional API endpoints or managed services published using
10822 # Private Service Connect
10823 #
10824 #
10825 #
10826 # Applicable backend service types can be:
10827 #
10828 # - A global backend service with the loadBalancingScheme set to
10829 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
10830 # - A regional backend
10831 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
10832 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
10833 # supported for Serverless NEGs.
10834 #
10835 #
10836 #
10837 # Not supported when the backend service is referenced by a URL map that is
10838 # bound to target gRPC proxy that has validateForProxyless field set to true.
10839 # pool for the backend service.
10840 &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
10841 # or 30s.
10842 #
10843 # After a backend endpoint is returned back to the load balancing pool, it
10844 # can be ejected again in another ejection analysis. Thus, the total ejection
10845 # time is equal to the base ejection time multiplied by the number of times
10846 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
10847 # as a count of seconds and fractions of seconds at nanosecond
10848 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10849 # or &quot;month&quot;. Range is approximately 10,000 years.
10850 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10851 # Durations less than one second are represented with a 0
10852 # `seconds` field and a positive `nanos` field. Must be from 0
10853 # to 999,999,999 inclusive.
10854 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10855 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10856 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10857 },
10858 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
10859 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
10860 # return code qualifies as an error. Defaults to 5.
10861 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
10862 # connection errors that are mapped to one of those status codes) before a
10863 # consecutive gateway failure ejection occurs. Defaults to 3.
10864 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10865 # outlier status is detected through consecutive 5xx. This setting can be
10866 # used to disable ejection or to ramp it up slowly. Defaults to 0.
10867 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10868 # outlier status is detected through consecutive gateway failures. This
10869 # setting can be used to disable ejection or to ramp it up slowly. Defaults
10870 # to 100.
10871 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
10872 # outlier status is detected through success rate statistics. This setting
10873 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
10874 #
10875 # Not supported when the backend service uses Serverless NEG.
10876 &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
10877 # ejections and backend endpoints being returned to service. The interval is
10878 # equal to the number of seconds as defined in
10879 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
10880 # in outlierDetection.interval.nanos. Defaults to 1 second.
10881 # as a count of seconds and fractions of seconds at nanosecond
10882 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10883 # or &quot;month&quot;. Range is approximately 10,000 years.
10884 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10885 # Durations less than one second are represented with a 0
10886 # `seconds` field and a positive `nanos` field. Must be from 0
10887 # to 999,999,999 inclusive.
10888 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10889 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10890 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10891 },
10892 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
10893 # backend service that can be ejected if the ejection conditions are met.
10894 # Defaults to 50%.
10895 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
10896 # enough request volume to detect success rate outliers. If the number of
10897 # backend endpoints is fewer than this setting, outlier detection via success
10898 # rate statistics is not performed for any backend endpoint in the load
10899 # balancing pool. Defaults to 5.
10900 #
10901 # Not supported when the backend service uses Serverless NEG.
10902 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
10903 # (as defined by the interval duration above) to include this backend
10904 # endpoint in success rate based outlier detection. If the volume is lower
10905 # than this setting, outlier detection via success rate statistics is not
10906 # performed for that backend endpoint. Defaults to 100.
10907 #
10908 # Not supported when the backend service uses Serverless NEG.
10909 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
10910 # outlier ejection. The ejection threshold is the difference between the mean
10911 # success rate, and the product of this factor and the standard deviation of
10912 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
10913 # is divided by a thousand to get a double. That is, if the desired factor
10914 # is 1.9, the runtime value should be 1900. Defaults to 1900.
10915 #
10916 # Not supported when the backend service uses Serverless NEG.
10917 },
10918 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
10919 # as part of resource payload.
10920 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
10921 # Tag keys and values have the same definition as resource
10922 # manager tags. The field is allowed for INSERT
10923 # only. The keys/values to set on the resource should be specified in
10924 # either ID { : } or Namespaced format
10925 # { : }.
10926 # For example the following are valid inputs:
10927 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
10928 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
10929 # Note:
10930 # * Invalid combinations of ID &amp; namespaced format is not supported. For
10931 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
10932 &quot;a_key&quot;: &quot;A String&quot;,
10933 },
10934 },
10935 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
10936 # the backend. The default value is 80.
10937 # For internal passthrough Network Load Balancers and external passthrough
10938 # Network Load Balancers, omit port.
10939 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
10940 # communication to the backend VMs in that group. The
10941 # named port must be [defined on each backend instance
10942 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
10943 # This parameter has no meaning if the backends are NEGs. For internal
10944 # passthrough Network Load Balancers and external passthrough Network Load
10945 # Balancers, omit port_name.
10946 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
10947 # with backends.
10948 #
10949 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
10950 # depending on the chosen load balancer or Traffic Director configuration.
10951 # Refer to the documentation for the load balancers or for Traffic Director
10952 # for more information.
10953 #
10954 # Must be set to GRPC when the backend service is referenced by a URL map
10955 # that is bound to target gRPC proxy.
10956 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
10957 # resides. This field is not applicable to global backend services.
10958 # You must specify this field as part of the HTTP request URL. It is
10959 # not settable as a field in the request body.
10960 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
10961 # backend service.
10962 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
10963 # service. This field is applicable to a global backend service with the
10964 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
10965 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
10966 &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
10967 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
10968 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
10969 # private storage buckets that support Signature Version 4 for authentication.
10970 # The service name for generating the authentication header will always default
10971 # to &#x27;s3&#x27;.
10972 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
10973 # creating a backend that uses AWS v4 signature authentication, but will not
10974 # be returned as part of the configuration when queried with a REST API GET
10975 # request.
10976 #
10977 # @InputOnly
10978 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
10979 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
10980 # keep track of different iterations of your access key.
10981 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
10982 # the name of the region your cloud uses to host your origin. For example,
10983 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
10984 },
10985 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
10986 # that describes how clients should authenticate with this service&#x27;s
10987 # backends.
10988 #
10989 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
10990 # to INTERNAL_SELF_MANAGED.
10991 #
10992 # If left blank, communications are not encrypted.
10993 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
10994 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
10995 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
10996 # specified values, the communication continues. Otherwise, it fails. This
10997 # additional check enables the client to verify that the server is authorized
10998 # to run the requested service.
10999 #
11000 # Note that the contents of the server
11001 # certificate&#x27;s subjectAltName field are configured by the
11002 # Public Key Infrastructure which provisions server identities.
11003 #
11004 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
11005 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
11006 # mode).
11007 &quot;A String&quot;,
11008 ],
11009 },
11010 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11011 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
11012 #
11013 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
11014 # If set, lists of backends and health checks must be both empty.
11015 &quot;A String&quot;,
11016 ],
11017 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
11018 #
11019 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
11020 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
11021 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
11022 #
11023 # Only NONE and HEADER_FIELD are supported
11024 # when the backend service is referenced by a URL map that is bound to
11025 # target gRPC proxy that has validateForProxyless field set to true.
11026 #
11027 # For more details, see:
11028 # [Session
11029 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
11030 #
11031 # sessionAffinity cannot be specified with haPolicy.
11032 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
11033 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
11034 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
11035 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
11036 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
11037 # as a count of seconds and fractions of seconds at nanosecond
11038 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11039 # or &quot;month&quot;. Range is approximately 10,000 years.
11040 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11041 # Durations less than one second are represented with a 0
11042 # `seconds` field and a positive `nanos` field. Must be from 0
11043 # to 999,999,999 inclusive.
11044 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11045 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11046 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11047 },
11048 },
11049 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
11050 # Currently this is applicable only for Internal TCP/UDP load balancing,
11051 # Internal HTTP(S) load balancing and Traffic Director.
11052 &quot;policy&quot;: &quot;A String&quot;,
11053 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
11054 # each service mesh client.
11055 #
11056 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
11057 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
11058 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
11059 # `INTERNAL_SELF_MANAGED`.
11060 #
11061 # `subset_size` is optional for Internal HTTP(S) load balancing
11062 # and required for Traffic Director.
11063 #
11064 # If you do not provide this value, Cloud Load Balancing will calculate it
11065 # dynamically to optimize the number of proxies/clients visible to each
11066 # backend and vice versa.
11067 #
11068 # Must be greater than 0. If `subset_size` is larger than the number of
11069 # backends/endpoints, then subsetting is disabled.
11070 },
11071 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
11072 # type of load balancer. For more information see,
11073 # Backend service settings.
11074 # The default is 30 seconds.
11075 # The full range of timeout values allowed goes from 1
11076 # through 2,147,483,647 seconds.
11077 #
11078 # This value can be overridden in the PathMatcher configuration of the
11079 # UrlMap that references this backend service.
11080 #
11081 # Not supported when the backend service is referenced by a URL map that is
11082 # bound to target gRPC proxy that has validateForProxyless field set to true.
11083 # Instead, use maxStreamDuration.
11084 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
11085 # when the backend protocol is SSL, HTTPS or HTTP2.
11086 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
11087 # networksecurity.googleapis.com namespace. Can be used in authenticating
11088 # TLS connections to the backend, as specified by the authenticationMode
11089 # field. Can only be specified if authenticationMode is not NONE.
11090 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
11091 #
11092 #
11093 # Use this property to configure the load balancer back-end to use
11094 # certificates and roots of trust provisioned by the Managed Workload
11095 # Identity system.
11096 #
11097 # The `identity` property is the
11098 # fully-specified SPIFFE ID to use in the SVID presented by the Load
11099 # Balancer Workload.
11100 #
11101 # The SPIFFE ID must be a resource starting with the
11102 # `trustDomain` property value, followed by the path to the Managed
11103 # Workload Identity.
11104 #
11105 # Supported SPIFFE ID format:
11106 #
11107 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
11108 #
11109 #
11110 # The Trust Domain within the Managed Identity must refer to a valid
11111 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
11112 # will be inherited from the Workload Identity Pool.
11113 #
11114 # Restrictions:
11115 #
11116 # - If you set the `identity` property, you cannot manually set
11117 # the following fields:
11118 # - tlsSettings.sni
11119 # - tlsSettings.subjectAltNames
11120 # - tlsSettings.authenticationConfig
11121 #
11122 #
11123 # When defining a `identity` for a RegionBackendServices, the
11124 # corresponding Workload Identity Pool must have a ca_pool
11125 # configured in the same region.
11126 #
11127 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
11128 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
11129 # balancer sends this string as the SNI hostname in the TLS connection to
11130 # the backend, and requires that this string match a Subject Alternative
11131 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
11132 # NEG backend, if the SNI is specified here, the load balancer uses it
11133 # regardless of whether the Regional Internet NEG is specified with FQDN or
11134 # IP address and port. When both sni and subjectAltNames[] are specified,
11135 # the load balancer matches the backend certificate&#x27;s SAN only to
11136 # subjectAltNames[].
11137 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
11138 # verifies during a TLS handshake with the backend. When the server
11139 # presents its X.509 certificate to the Load Balancer, the Load Balancer
11140 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
11141 # match one of the subjectAltNames in the list. This field is limited to 5
11142 # entries. When both sni and subjectAltNames[] are specified, the load
11143 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
11144 { # A Subject Alternative Name that the load balancer matches against the SAN
11145 # field in the TLS certificate provided by the backend, specified as either
11146 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
11147 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
11148 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
11149 },
11150 ],
11151 },
11152 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
11153 {
11154 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
11155 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
11156 # and ForwardingRule.
11157 },
11158 ],
11159 }
11160
11161 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11162 that if you must retry your request, the server will know to ignore the
11163 request if it has already been completed.
11164
11165 For example, consider a situation where you make an initial request and
11166 the request times out. If you make the request again with the same
11167 request ID, the server can check if original operation with the same
11168 request ID was received, and if so, will ignore the second request. This
11169 prevents clients from accidentally creating duplicate commitments.
11170
11171 The request ID must be
11172 a valid UUID with the exception that zero UUID is not supported
11173 (00000000-0000-0000-0000-000000000000).
11174 x__xgafv: string, V1 error format.
11175 Allowed values
11176 1 - v1 error format
11177 2 - v2 error format
11178
11179 Returns:
11180 An object of the form:
11181
11182 { # Represents an Operation resource.
11183 #
11184 # Google Compute Engine has three Operation resources:
11185 #
11186 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
11187 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
11188 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
11189 #
11190 # You can use an operation resource to manage asynchronous API requests.
11191 # For more information, readHandling
11192 # API responses.
11193 #
11194 # Operations can be global, regional or zonal.
11195 #
11196 # - For global operations, use the `globalOperations`
11197 # resource.
11198 # - For regional operations, use the
11199 # `regionOperations` resource.
11200 # - For zonal operations, use
11201 # the `zoneOperations` resource.
11202 #
11203 #
11204 #
11205 # For more information, read
11206 # Global, Regional, and Zonal Resources.
11207 #
11208 # Note that completed Operation resources have a limited
11209 # retention period.
11210 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11211 # Not present otherwise.
11212 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11213 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11214 # set when the operation is created.
11215 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11216 # text format.
11217 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11218 # this field will be populated.
11219 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11220 # operation.
11221 {
11222 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11223 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11224 # details. There is a set of defined message types to use for providing
11225 # details.The syntax depends on the error code. For example,
11226 # QuotaExceededInfo will have details when the error code is
11227 # QUOTA_EXCEEDED.
11228 {
11229 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11230 #
11231 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11232 # is not enabled:
11233 #
11234 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11235 # &quot;domain&quot;: &quot;googleapis.com&quot;
11236 # &quot;metadata&quot;: {
11237 # &quot;resource&quot;: &quot;projects/123&quot;,
11238 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11239 # }
11240 # }
11241 #
11242 # This response indicates that the pubsub.googleapis.com API is not enabled.
11243 #
11244 # Example of an error that is returned when attempting to create a Spanner
11245 # instance in a region that is out of stock:
11246 #
11247 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11248 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11249 # &quot;metadata&quot;: {
11250 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11251 # }
11252 # }
11253 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11254 # is typically the registered service name of the tool or product that
11255 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11256 # generated by some common infrastructure, the error domain must be a
11257 # globally unique value that identifies the infrastructure. For Google API
11258 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11259 &quot;metadatas&quot;: { # Additional structured details about this error.
11260 #
11261 # Keys must match a regular expression of `a-z+` but should
11262 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11263 # length. When identifying the current value of an exceeded limit, the units
11264 # should be contained in the key, not the value. For example, rather than
11265 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11266 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11267 # instances that can be created in a single (batch) request.
11268 &quot;a_key&quot;: &quot;A String&quot;,
11269 },
11270 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11271 # proximate cause of the error. Error reasons are unique within a particular
11272 # domain of errors. This should be at most 63 characters and match a
11273 # regular expression of `A-Z+[A-Z0-9]`, which represents
11274 # UPPER_SNAKE_CASE.
11275 },
11276 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11277 #
11278 # For example, if a quota check failed with an error indicating the calling
11279 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11280 # directly to the right place in the developer console to flip the bit.
11281 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11282 { # Describes a URL link.
11283 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11284 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11285 },
11286 ],
11287 },
11288 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11289 # which can be attached to an RPC error.
11290 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11291 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11292 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11293 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11294 },
11295 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11296 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11297 &quot;a_key&quot;: &quot;A String&quot;,
11298 },
11299 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11300 # type or metric.
11301 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11302 # or metric.
11303 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11304 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11305 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11306 },
11307 },
11308 ],
11309 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11310 # This property is optional.
11311 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11312 },
11313 ],
11314 },
11315 &quot;getVersionOperationMetadata&quot;: {
11316 &quot;inlineSbomInfo&quot;: {
11317 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11318 # appropriate identifiers.
11319 &quot;a_key&quot;: &quot;A String&quot;,
11320 },
11321 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11322 # identifiers.
11323 &quot;a_key&quot;: &quot;A String&quot;,
11324 },
11325 },
11326 },
11327 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11328 # message that was returned, such as `NOT FOUND`.
11329 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11330 # status code that was returned. For example, a `404` means the
11331 # resource was not found.
11332 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11333 # defined by the server.
11334 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11335 # This value is inRFC3339
11336 # text format.
11337 &quot;instancesBulkInsertOperationMetadata&quot;: {
11338 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11339 # Example key: zones/us-central1-a
11340 &quot;a_key&quot;: {
11341 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11342 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11343 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11344 # error.
11345 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11346 # if the flow is rolling forward or rolling back.
11347 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11348 },
11349 },
11350 },
11351 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11352 # Operation resources.
11353 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11354 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11355 # group of operations results from a `bulkInsert` API request.
11356 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11357 # `update`, or `delete`, and so on.
11358 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11359 # There is no requirement that this be linear or support any granularity of
11360 # operations. This should not be used to guess when the operation will be
11361 # complete. This number should monotonically increase as the operation
11362 # progresses.
11363 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11364 # applicable when performing regional operations.
11365 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11366 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11367 # this field will contain information on all underlying zonal actions and
11368 # their state.
11369 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11370 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11371 # Example key: zones/us-central1-a
11372 &quot;a_key&quot;: {
11373 &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
11374 # populated.
11375 # different programming environments, including REST APIs and RPC APIs. It is
11376 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11377 # three pieces of data: error code, error message, and error details.
11378 #
11379 # You can find out more about this error model and how to work with it in the
11380 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11381 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11382 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11383 # message types for APIs to use.
11384 {
11385 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11386 },
11387 ],
11388 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11389 # user-facing error message should be localized and sent in the
11390 # google.rpc.Status.details field, or localized by the client.
11391 },
11392 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11393 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11394 },
11395 },
11396 },
11397 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11398 # This value is inRFC3339
11399 # text format.
11400 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11401 # following:
11402 # `PENDING`, `RUNNING`, or `DONE`.
11403 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11404 # operation.
11405 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11406 # of the target resource.
11407 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11408 # operations related to creating a snapshot, this points to the disk
11409 # that the snapshot was created from.
11410 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11411 # `[email protected]` or
11412 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11413 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11414 # operation, this field will be populated.
11415 {
11416 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11417 # Engine returns NO_RESULTS_ON_PAGE if there
11418 # are no results in the response.
11419 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11420 # value format. For example:
11421 #
11422 # &quot;data&quot;: [
11423 # {
11424 # &quot;key&quot;: &quot;scope&quot;,
11425 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11426 # }
11427 {
11428 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11429 # returned. For example, for warnings where there are no results in a list
11430 # request for a particular zone, this key might be scope and
11431 # the key value might be the zone name. Other examples might be a key
11432 # indicating a deprecated resource and a suggested replacement, or a
11433 # warning about invalid network settings (for example, if an instance
11434 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11435 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11436 },
11437 ],
11438 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11439 },
11440 ],
11441 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11442 # applicable when performing per-zone operations.
11443 }</pre>
11444 </div>
11445
11446 <div class="method">
11447 <code class="details" id="setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
11448 <pre>Sets the edge security policy for the specified backend service.
11449
11450 Args:
11451 project: string, Project ID for this request. (required)
11452 backendService: string, Name of the BackendService resource to which the edge security policy
11453 should be set. The name should conform to RFC1035. (required)
11454 body: object, The request body.
11455 The object takes the form of:
11456
11457 {
11458 &quot;securityPolicy&quot;: &quot;A String&quot;,
11459 }
11460
11461 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11462 that if you must retry your request, the server will know to ignore the
11463 request if it has already been completed.
11464
11465 For example, consider a situation where you make an initial request and
11466 the request times out. If you make the request again with the same
11467 request ID, the server can check if original operation with the same
11468 request ID was received, and if so, will ignore the second request. This
11469 prevents clients from accidentally creating duplicate commitments.
11470
11471 The request ID must be
11472 a valid UUID with the exception that zero UUID is not supported
11473 (00000000-0000-0000-0000-000000000000).
11474 x__xgafv: string, V1 error format.
11475 Allowed values
11476 1 - v1 error format
11477 2 - v2 error format
11478
11479 Returns:
11480 An object of the form:
11481
11482 { # Represents an Operation resource.
11483 #
11484 # Google Compute Engine has three Operation resources:
11485 #
11486 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
11487 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
11488 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
11489 #
11490 # You can use an operation resource to manage asynchronous API requests.
11491 # For more information, readHandling
11492 # API responses.
11493 #
11494 # Operations can be global, regional or zonal.
11495 #
11496 # - For global operations, use the `globalOperations`
11497 # resource.
11498 # - For regional operations, use the
11499 # `regionOperations` resource.
11500 # - For zonal operations, use
11501 # the `zoneOperations` resource.
11502 #
11503 #
11504 #
11505 # For more information, read
11506 # Global, Regional, and Zonal Resources.
11507 #
11508 # Note that completed Operation resources have a limited
11509 # retention period.
11510 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11511 # Not present otherwise.
11512 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11513 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11514 # set when the operation is created.
11515 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11516 # text format.
11517 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11518 # this field will be populated.
11519 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11520 # operation.
11521 {
11522 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11523 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11524 # details. There is a set of defined message types to use for providing
11525 # details.The syntax depends on the error code. For example,
11526 # QuotaExceededInfo will have details when the error code is
11527 # QUOTA_EXCEEDED.
11528 {
11529 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11530 #
11531 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11532 # is not enabled:
11533 #
11534 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11535 # &quot;domain&quot;: &quot;googleapis.com&quot;
11536 # &quot;metadata&quot;: {
11537 # &quot;resource&quot;: &quot;projects/123&quot;,
11538 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11539 # }
11540 # }
11541 #
11542 # This response indicates that the pubsub.googleapis.com API is not enabled.
11543 #
11544 # Example of an error that is returned when attempting to create a Spanner
11545 # instance in a region that is out of stock:
11546 #
11547 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11548 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11549 # &quot;metadata&quot;: {
11550 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11551 # }
11552 # }
11553 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11554 # is typically the registered service name of the tool or product that
11555 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11556 # generated by some common infrastructure, the error domain must be a
11557 # globally unique value that identifies the infrastructure. For Google API
11558 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11559 &quot;metadatas&quot;: { # Additional structured details about this error.
11560 #
11561 # Keys must match a regular expression of `a-z+` but should
11562 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11563 # length. When identifying the current value of an exceeded limit, the units
11564 # should be contained in the key, not the value. For example, rather than
11565 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11566 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11567 # instances that can be created in a single (batch) request.
11568 &quot;a_key&quot;: &quot;A String&quot;,
11569 },
11570 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11571 # proximate cause of the error. Error reasons are unique within a particular
11572 # domain of errors. This should be at most 63 characters and match a
11573 # regular expression of `A-Z+[A-Z0-9]`, which represents
11574 # UPPER_SNAKE_CASE.
11575 },
11576 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11577 #
11578 # For example, if a quota check failed with an error indicating the calling
11579 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11580 # directly to the right place in the developer console to flip the bit.
11581 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11582 { # Describes a URL link.
11583 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11584 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11585 },
11586 ],
11587 },
11588 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11589 # which can be attached to an RPC error.
11590 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11591 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11592 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11593 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11594 },
11595 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11596 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11597 &quot;a_key&quot;: &quot;A String&quot;,
11598 },
11599 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11600 # type or metric.
11601 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11602 # or metric.
11603 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11604 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11605 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11606 },
11607 },
11608 ],
11609 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11610 # This property is optional.
11611 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11612 },
11613 ],
11614 },
11615 &quot;getVersionOperationMetadata&quot;: {
11616 &quot;inlineSbomInfo&quot;: {
11617 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11618 # appropriate identifiers.
11619 &quot;a_key&quot;: &quot;A String&quot;,
11620 },
11621 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11622 # identifiers.
11623 &quot;a_key&quot;: &quot;A String&quot;,
11624 },
11625 },
11626 },
11627 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11628 # message that was returned, such as `NOT FOUND`.
11629 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11630 # status code that was returned. For example, a `404` means the
11631 # resource was not found.
11632 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11633 # defined by the server.
11634 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11635 # This value is inRFC3339
11636 # text format.
11637 &quot;instancesBulkInsertOperationMetadata&quot;: {
11638 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11639 # Example key: zones/us-central1-a
11640 &quot;a_key&quot;: {
11641 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11642 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11643 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11644 # error.
11645 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11646 # if the flow is rolling forward or rolling back.
11647 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11648 },
11649 },
11650 },
11651 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11652 # Operation resources.
11653 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11654 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11655 # group of operations results from a `bulkInsert` API request.
11656 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11657 # `update`, or `delete`, and so on.
11658 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11659 # There is no requirement that this be linear or support any granularity of
11660 # operations. This should not be used to guess when the operation will be
11661 # complete. This number should monotonically increase as the operation
11662 # progresses.
11663 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11664 # applicable when performing regional operations.
11665 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11666 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11667 # this field will contain information on all underlying zonal actions and
11668 # their state.
11669 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11670 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11671 # Example key: zones/us-central1-a
11672 &quot;a_key&quot;: {
11673 &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
11674 # populated.
11675 # different programming environments, including REST APIs and RPC APIs. It is
11676 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11677 # three pieces of data: error code, error message, and error details.
11678 #
11679 # You can find out more about this error model and how to work with it in the
11680 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11681 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11682 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11683 # message types for APIs to use.
11684 {
11685 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11686 },
11687 ],
11688 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11689 # user-facing error message should be localized and sent in the
11690 # google.rpc.Status.details field, or localized by the client.
11691 },
11692 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11693 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11694 },
11695 },
11696 },
11697 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11698 # This value is inRFC3339
11699 # text format.
11700 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11701 # following:
11702 # `PENDING`, `RUNNING`, or `DONE`.
11703 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11704 # operation.
11705 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11706 # of the target resource.
11707 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11708 # operations related to creating a snapshot, this points to the disk
11709 # that the snapshot was created from.
11710 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11711 # `[email protected]` or
11712 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11713 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11714 # operation, this field will be populated.
11715 {
11716 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11717 # Engine returns NO_RESULTS_ON_PAGE if there
11718 # are no results in the response.
11719 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11720 # value format. For example:
11721 #
11722 # &quot;data&quot;: [
11723 # {
11724 # &quot;key&quot;: &quot;scope&quot;,
11725 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11726 # }
11727 {
11728 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11729 # returned. For example, for warnings where there are no results in a list
11730 # request for a particular zone, this key might be scope and
11731 # the key value might be the zone name. Other examples might be a key
11732 # indicating a deprecated resource and a suggested replacement, or a
11733 # warning about invalid network settings (for example, if an instance
11734 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11735 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11736 },
11737 ],
11738 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11739 },
11740 ],
11741 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11742 # applicable when performing per-zone operations.
11743 }</pre>
11744 </div>
11745
11746 <div class="method">
11747 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
11748 <pre>Sets the access control policy on the specified resource.
11749 Replaces any existing policy.
11750
11751 Args:
11752 project: string, Project ID for this request. (required)
11753 resource: string, Name or id of the resource for this request. (required)
11754 body: object, The request body.
11755 The object takes the form of:
11756
11757 {
11758 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
11759 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
11760 { # Associates `members`, or principals, with a `role`.
11761 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
11762 #
11763 # If the condition evaluates to `true`, then this binding applies to the
11764 # current request.
11765 #
11766 # If the condition evaluates to `false`, then this binding does not apply to
11767 # the current request. However, a different role binding might grant the same
11768 # role to one or more of the principals in this binding.
11769 #
11770 # To learn which resources support conditions in their IAM policies, see the
11771 # [IAM
11772 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11773 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
11774 # are documented at https://github.com/google/cel-spec.
11775 #
11776 # Example (Comparison):
11777 #
11778 # title: &quot;Summary size limit&quot;
11779 # description: &quot;Determines if a summary is less than 100 chars&quot;
11780 # expression: &quot;document.summary.size() &lt; 100&quot;
11781 #
11782 # Example (Equality):
11783 #
11784 # title: &quot;Requestor is owner&quot;
11785 # description: &quot;Determines if requestor is the document owner&quot;
11786 # expression: &quot;document.owner == request.auth.claims.email&quot;
11787 #
11788 # Example (Logic):
11789 #
11790 # title: &quot;Public documents&quot;
11791 # description: &quot;Determine whether the document should be publicly visible&quot;
11792 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
11793 #
11794 # Example (Data Manipulation):
11795 #
11796 # title: &quot;Notification string&quot;
11797 # description: &quot;Create a notification string with a timestamp.&quot;
11798 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
11799 #
11800 # The exact variables and functions that may be referenced within an expression
11801 # are determined by the service that evaluates it. See the service
11802 # documentation for additional information.
11803 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
11804 # describes the expression, e.g. when hovered over it in a UI.
11805 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
11806 # syntax.
11807 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
11808 # reporting, e.g. a file name and a position in the file.
11809 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
11810 # its purpose. This can be used e.g. in UIs which allow to enter the
11811 # expression.
11812 },
11813 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
11814 # `members` can have the following values:
11815 #
11816 # * `allUsers`: A special identifier that represents anyone who is
11817 # on the internet; with or without a Google account.
11818 #
11819 # * `allAuthenticatedUsers`: A special identifier that represents anyone
11820 # who is authenticated with a Google account or a service account.
11821 # Does not include identities that come from external identity providers
11822 # (IdPs) through identity federation.
11823 #
11824 # * `user:{emailid}`: An email address that represents a specific Google
11825 # account. For example, `[email protected]` .
11826 #
11827 #
11828 # * `serviceAccount:{emailid}`: An email address that represents a Google
11829 # service account. For example,
11830 # `[email protected]`.
11831 #
11832 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
11833 # identifier for a
11834 # [Kubernetes service
11835 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
11836 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
11837 #
11838 # * `group:{emailid}`: An email address that represents a Google group.
11839 # For example, `[email protected]`.
11840 #
11841 #
11842 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
11843 # users of that domain. For example, `google.com` or `example.com`.
11844 #
11845 #
11846 #
11847 #
11848 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11849 # A single identity in a workforce identity pool.
11850 #
11851 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
11852 # All workforce identities in a group.
11853 #
11854 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11855 # All workforce identities with a specific attribute value.
11856 #
11857 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
11858 # All identities in a workforce identity pool.
11859 #
11860 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
11861 # A single identity in a workload identity pool.
11862 #
11863 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
11864 # A workload identity pool group.
11865 #
11866 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11867 # All identities in a workload identity pool with a certain attribute.
11868 #
11869 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
11870 # All identities in a workload identity pool.
11871 #
11872 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
11873 # identifier) representing a user that has been recently deleted. For
11874 # example, `[email protected]?uid=123456789012345678901`. If the user is
11875 # recovered, this value reverts to `user:{emailid}` and the recovered user
11876 # retains the role in the binding.
11877 #
11878 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
11879 # unique identifier) representing a service account that has been recently
11880 # deleted. For example,
11881 # `[email protected]?uid=123456789012345678901`.
11882 # If the service account is undeleted, this value reverts to
11883 # `serviceAccount:{emailid}` and the undeleted service account retains the
11884 # role in the binding.
11885 #
11886 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
11887 # identifier) representing a Google group that has been recently
11888 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
11889 # the group is recovered, this value reverts to `group:{emailid}` and the
11890 # recovered group retains the role in the binding.
11891 #
11892 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11893 # Deleted single identity in a workforce identity pool. For example,
11894 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
11895 &quot;A String&quot;,
11896 ],
11897 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
11898 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
11899 #
11900 # For an overview of the IAM roles and permissions, see the
11901 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
11902 # a list of the available pre-defined roles, see
11903 # [here](https://cloud.google.com/iam/docs/understanding-roles).
11904 },
11905 ],
11906 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
11907 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
11908 &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
11909 # the policy is limited to a few 10s of KB. An empty policy is in general a
11910 # valid policy but certain services (like Projects) might reject them.
11911 # controls for Google Cloud resources.
11912 #
11913 #
11914 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
11915 # `members`, or principals, to a single `role`. Principals can be user
11916 # accounts, service accounts, Google groups, and domains (such as G Suite). A
11917 # `role` is a named list of permissions; each `role` can be an IAM predefined
11918 # role or a user-created custom role.
11919 #
11920 # For some types of Google Cloud resources, a `binding` can also specify a
11921 # `condition`, which is a logical expression that allows access to a resource
11922 # only if the expression evaluates to `true`. A condition can add constraints
11923 # based on attributes of the request, the resource, or both. To learn which
11924 # resources support conditions in their IAM policies, see the
11925 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11926 #
11927 # **JSON example:**
11928 #
11929 # ```
11930 # {
11931 # &quot;bindings&quot;: [
11932 # {
11933 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
11934 # &quot;members&quot;: [
11935 # &quot;user:[email protected]&quot;,
11936 # &quot;group:[email protected]&quot;,
11937 # &quot;domain:google.com&quot;,
11938 # &quot;serviceAccount:[email protected]&quot;
11939 # ]
11940 # },
11941 # {
11942 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
11943 # &quot;members&quot;: [
11944 # &quot;user:[email protected]&quot;
11945 # ],
11946 # &quot;condition&quot;: {
11947 # &quot;title&quot;: &quot;expirable access&quot;,
11948 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
11949 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
11950 # }
11951 # }
11952 # ],
11953 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
11954 # &quot;version&quot;: 3
11955 # }
11956 # ```
11957 #
11958 # **YAML example:**
11959 #
11960 # ```
11961 # bindings:
11962 # - members:
11963 # - user:[email protected]
11964 # - group:[email protected]
11965 # - domain:google.com
11966 # - serviceAccount:[email protected]
11967 # role: roles/resourcemanager.organizationAdmin
11968 # - members:
11969 # - user:[email protected]
11970 # role: roles/resourcemanager.organizationViewer
11971 # condition:
11972 # title: expirable access
11973 # description: Does not grant access after Sep 2020
11974 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
11975 # etag: BwWWja0YfJA=
11976 # version: 3
11977 # ```
11978 #
11979 # For a description of IAM and its features, see the
11980 # [IAM documentation](https://cloud.google.com/iam/docs/).
11981 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
11982 { # Specifies the audit configuration for a service.
11983 # The configuration determines which permission types are logged, and what
11984 # identities, if any, are exempted from logging.
11985 # An AuditConfig must have one or more AuditLogConfigs.
11986 #
11987 # If there are AuditConfigs for both `allServices` and a specific service,
11988 # the union of the two AuditConfigs is used for that service: the log_types
11989 # specified in each AuditConfig are enabled, and the exempted_members in each
11990 # AuditLogConfig are exempted.
11991 #
11992 # Example Policy with multiple AuditConfigs:
11993 #
11994 # {
11995 # &quot;audit_configs&quot;: [
11996 # {
11997 # &quot;service&quot;: &quot;allServices&quot;,
11998 # &quot;audit_log_configs&quot;: [
11999 # {
12000 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
12001 # &quot;exempted_members&quot;: [
12002 # &quot;user:[email protected]&quot;
12003 # ]
12004 # },
12005 # {
12006 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
12007 # },
12008 # {
12009 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
12010 # }
12011 # ]
12012 # },
12013 # {
12014 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
12015 # &quot;audit_log_configs&quot;: [
12016 # {
12017 # &quot;log_type&quot;: &quot;DATA_READ&quot;
12018 # },
12019 # {
12020 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
12021 # &quot;exempted_members&quot;: [
12022 # &quot;user:[email protected]&quot;
12023 # ]
12024 # }
12025 # ]
12026 # }
12027 # ]
12028 # }
12029 #
12030 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
12031 # logging. It also exempts `[email protected]` from DATA_READ logging, and
12032 # `[email protected]` from DATA_WRITE logging.
12033 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
12034 { # Provides the configuration for logging a type of permissions.
12035 # Example:
12036 #
12037 # {
12038 # &quot;audit_log_configs&quot;: [
12039 # {
12040 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
12041 # &quot;exempted_members&quot;: [
12042 # &quot;user:[email protected]&quot;
12043 # ]
12044 # },
12045 # {
12046 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
12047 # }
12048 # ]
12049 # }
12050 #
12051 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
12052 # [email protected] from DATA_READ logging.
12053 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
12054 # permission.
12055 # Follows the same format of Binding.members.
12056 &quot;A String&quot;,
12057 ],
12058 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
12059 },
12060 ],
12061 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
12062 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
12063 # `allServices` is a special value that covers all services.
12064 },
12065 ],
12066 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
12067 # may specify a `condition` that determines how and when the `bindings` are
12068 # applied. Each of the `bindings` must contain at least one principal.
12069 #
12070 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
12071 # of these principals can be Google groups. Each occurrence of a principal
12072 # counts towards these limits. For example, if the `bindings` grant 50
12073 # different roles to `user:[email protected]`, and not to any other
12074 # principal, then you can add another 1,450 principals to the `bindings` in
12075 # the `Policy`.
12076 { # Associates `members`, or principals, with a `role`.
12077 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
12078 #
12079 # If the condition evaluates to `true`, then this binding applies to the
12080 # current request.
12081 #
12082 # If the condition evaluates to `false`, then this binding does not apply to
12083 # the current request. However, a different role binding might grant the same
12084 # role to one or more of the principals in this binding.
12085 #
12086 # To learn which resources support conditions in their IAM policies, see the
12087 # [IAM
12088 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
12089 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
12090 # are documented at https://github.com/google/cel-spec.
12091 #
12092 # Example (Comparison):
12093 #
12094 # title: &quot;Summary size limit&quot;
12095 # description: &quot;Determines if a summary is less than 100 chars&quot;
12096 # expression: &quot;document.summary.size() &lt; 100&quot;
12097 #
12098 # Example (Equality):
12099 #
12100 # title: &quot;Requestor is owner&quot;
12101 # description: &quot;Determines if requestor is the document owner&quot;
12102 # expression: &quot;document.owner == request.auth.claims.email&quot;
12103 #
12104 # Example (Logic):
12105 #
12106 # title: &quot;Public documents&quot;
12107 # description: &quot;Determine whether the document should be publicly visible&quot;
12108 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
12109 #
12110 # Example (Data Manipulation):
12111 #
12112 # title: &quot;Notification string&quot;
12113 # description: &quot;Create a notification string with a timestamp.&quot;
12114 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
12115 #
12116 # The exact variables and functions that may be referenced within an expression
12117 # are determined by the service that evaluates it. See the service
12118 # documentation for additional information.
12119 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
12120 # describes the expression, e.g. when hovered over it in a UI.
12121 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
12122 # syntax.
12123 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
12124 # reporting, e.g. a file name and a position in the file.
12125 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
12126 # its purpose. This can be used e.g. in UIs which allow to enter the
12127 # expression.
12128 },
12129 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
12130 # `members` can have the following values:
12131 #
12132 # * `allUsers`: A special identifier that represents anyone who is
12133 # on the internet; with or without a Google account.
12134 #
12135 # * `allAuthenticatedUsers`: A special identifier that represents anyone
12136 # who is authenticated with a Google account or a service account.
12137 # Does not include identities that come from external identity providers
12138 # (IdPs) through identity federation.
12139 #
12140 # * `user:{emailid}`: An email address that represents a specific Google
12141 # account. For example, `[email protected]` .
12142 #
12143 #
12144 # * `serviceAccount:{emailid}`: An email address that represents a Google
12145 # service account. For example,
12146 # `[email protected]`.
12147 #
12148 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
12149 # identifier for a
12150 # [Kubernetes service
12151 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
12152 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
12153 #
12154 # * `group:{emailid}`: An email address that represents a Google group.
12155 # For example, `[email protected]`.
12156 #
12157 #
12158 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
12159 # users of that domain. For example, `google.com` or `example.com`.
12160 #
12161 #
12162 #
12163 #
12164 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
12165 # A single identity in a workforce identity pool.
12166 #
12167 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
12168 # All workforce identities in a group.
12169 #
12170 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
12171 # All workforce identities with a specific attribute value.
12172 #
12173 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
12174 # All identities in a workforce identity pool.
12175 #
12176 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
12177 # A single identity in a workload identity pool.
12178 #
12179 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
12180 # A workload identity pool group.
12181 #
12182 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
12183 # All identities in a workload identity pool with a certain attribute.
12184 #
12185 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
12186 # All identities in a workload identity pool.
12187 #
12188 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
12189 # identifier) representing a user that has been recently deleted. For
12190 # example, `[email protected]?uid=123456789012345678901`. If the user is
12191 # recovered, this value reverts to `user:{emailid}` and the recovered user
12192 # retains the role in the binding.
12193 #
12194 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
12195 # unique identifier) representing a service account that has been recently
12196 # deleted. For example,
12197 # `[email protected]?uid=123456789012345678901`.
12198 # If the service account is undeleted, this value reverts to
12199 # `serviceAccount:{emailid}` and the undeleted service account retains the
12200 # role in the binding.
12201 #
12202 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
12203 # identifier) representing a Google group that has been recently
12204 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
12205 # the group is recovered, this value reverts to `group:{emailid}` and the
12206 # recovered group retains the role in the binding.
12207 #
12208 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
12209 # Deleted single identity in a workforce identity pool. For example,
12210 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
12211 &quot;A String&quot;,
12212 ],
12213 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
12214 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
12215 #
12216 # For an overview of the IAM roles and permissions, see the
12217 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
12218 # a list of the available pre-defined roles, see
12219 # [here](https://cloud.google.com/iam/docs/understanding-roles).
12220 },
12221 ],
12222 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
12223 # prevent simultaneous updates of a policy from overwriting each other.
12224 # It is strongly suggested that systems make use of the `etag` in the
12225 # read-modify-write cycle to perform policy updates in order to avoid race
12226 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
12227 # systems are expected to put that etag in the request to `setIamPolicy` to
12228 # ensure that their change will be applied to the same version of the policy.
12229 #
12230 # **Important:** If you use IAM Conditions, you must include the `etag` field
12231 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
12232 # you to overwrite a version `3` policy with a version `1` policy, and all of
12233 # the conditions in the version `3` policy are lost.
12234 &quot;version&quot;: 42, # Specifies the format of the policy.
12235 #
12236 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
12237 # are rejected.
12238 #
12239 # Any operation that affects conditional role bindings must specify version
12240 # `3`. This requirement applies to the following operations:
12241 #
12242 # * Getting a policy that includes a conditional role binding
12243 # * Adding a conditional role binding to a policy
12244 # * Changing a conditional role binding in a policy
12245 # * Removing any role binding, with or without a condition, from a policy
12246 # that includes conditions
12247 #
12248 # **Important:** If you use IAM Conditions, you must include the `etag` field
12249 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
12250 # you to overwrite a version `3` policy with a version `1` policy, and all of
12251 # the conditions in the version `3` policy are lost.
12252 #
12253 # If a policy does not include any conditions, operations on that policy may
12254 # specify any valid version or leave the field unset.
12255 #
12256 # To learn which resources support conditions in their IAM policies, see the
12257 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
12258 },
12259 }
12260
12261 x__xgafv: string, V1 error format.
12262 Allowed values
12263 1 - v1 error format
12264 2 - v2 error format
12265
12266 Returns:
12267 An object of the form:
12268
12269 { # An Identity and Access Management (IAM) policy, which specifies access
12270 # controls for Google Cloud resources.
12271 #
12272 #
12273 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
12274 # `members`, or principals, to a single `role`. Principals can be user
12275 # accounts, service accounts, Google groups, and domains (such as G Suite). A
12276 # `role` is a named list of permissions; each `role` can be an IAM predefined
12277 # role or a user-created custom role.
12278 #
12279 # For some types of Google Cloud resources, a `binding` can also specify a
12280 # `condition`, which is a logical expression that allows access to a resource
12281 # only if the expression evaluates to `true`. A condition can add constraints
12282 # based on attributes of the request, the resource, or both. To learn which
12283 # resources support conditions in their IAM policies, see the
12284 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
12285 #
12286 # **JSON example:**
12287 #
12288 # ```
12289 # {
12290 # &quot;bindings&quot;: [
12291 # {
12292 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
12293 # &quot;members&quot;: [
12294 # &quot;user:[email protected]&quot;,
12295 # &quot;group:[email protected]&quot;,
12296 # &quot;domain:google.com&quot;,
12297 # &quot;serviceAccount:[email protected]&quot;
12298 # ]
12299 # },
12300 # {
12301 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
12302 # &quot;members&quot;: [
12303 # &quot;user:[email protected]&quot;
12304 # ],
12305 # &quot;condition&quot;: {
12306 # &quot;title&quot;: &quot;expirable access&quot;,
12307 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
12308 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
12309 # }
12310 # }
12311 # ],
12312 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
12313 # &quot;version&quot;: 3
12314 # }
12315 # ```
12316 #
12317 # **YAML example:**
12318 #
12319 # ```
12320 # bindings:
12321 # - members:
12322 # - user:[email protected]
12323 # - group:[email protected]
12324 # - domain:google.com
12325 # - serviceAccount:[email protected]
12326 # role: roles/resourcemanager.organizationAdmin
12327 # - members:
12328 # - user:[email protected]
12329 # role: roles/resourcemanager.organizationViewer
12330 # condition:
12331 # title: expirable access
12332 # description: Does not grant access after Sep 2020
12333 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
12334 # etag: BwWWja0YfJA=
12335 # version: 3
12336 # ```
12337 #
12338 # For a description of IAM and its features, see the
12339 # [IAM documentation](https://cloud.google.com/iam/docs/).
12340 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
12341 { # Specifies the audit configuration for a service.
12342 # The configuration determines which permission types are logged, and what
12343 # identities, if any, are exempted from logging.
12344 # An AuditConfig must have one or more AuditLogConfigs.
12345 #
12346 # If there are AuditConfigs for both `allServices` and a specific service,
12347 # the union of the two AuditConfigs is used for that service: the log_types
12348 # specified in each AuditConfig are enabled, and the exempted_members in each
12349 # AuditLogConfig are exempted.
12350 #
12351 # Example Policy with multiple AuditConfigs:
12352 #
12353 # {
12354 # &quot;audit_configs&quot;: [
12355 # {
12356 # &quot;service&quot;: &quot;allServices&quot;,
12357 # &quot;audit_log_configs&quot;: [
12358 # {
12359 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
12360 # &quot;exempted_members&quot;: [
12361 # &quot;user:[email protected]&quot;
12362 # ]
12363 # },
12364 # {
12365 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
12366 # },
12367 # {
12368 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
12369 # }
12370 # ]
12371 # },
12372 # {
12373 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
12374 # &quot;audit_log_configs&quot;: [
12375 # {
12376 # &quot;log_type&quot;: &quot;DATA_READ&quot;
12377 # },
12378 # {
12379 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
12380 # &quot;exempted_members&quot;: [
12381 # &quot;user:[email protected]&quot;
12382 # ]
12383 # }
12384 # ]
12385 # }
12386 # ]
12387 # }
12388 #
12389 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
12390 # logging. It also exempts `[email protected]` from DATA_READ logging, and
12391 # `[email protected]` from DATA_WRITE logging.
12392 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
12393 { # Provides the configuration for logging a type of permissions.
12394 # Example:
12395 #
12396 # {
12397 # &quot;audit_log_configs&quot;: [
12398 # {
12399 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
12400 # &quot;exempted_members&quot;: [
12401 # &quot;user:[email protected]&quot;
12402 # ]
12403 # },
12404 # {
12405 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
12406 # }
12407 # ]
12408 # }
12409 #
12410 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
12411 # [email protected] from DATA_READ logging.
12412 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
12413 # permission.
12414 # Follows the same format of Binding.members.
12415 &quot;A String&quot;,
12416 ],
12417 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
12418 },
12419 ],
12420 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
12421 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
12422 # `allServices` is a special value that covers all services.
12423 },
12424 ],
12425 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
12426 # may specify a `condition` that determines how and when the `bindings` are
12427 # applied. Each of the `bindings` must contain at least one principal.
12428 #
12429 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
12430 # of these principals can be Google groups. Each occurrence of a principal
12431 # counts towards these limits. For example, if the `bindings` grant 50
12432 # different roles to `user:[email protected]`, and not to any other
12433 # principal, then you can add another 1,450 principals to the `bindings` in
12434 # the `Policy`.
12435 { # Associates `members`, or principals, with a `role`.
12436 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
12437 #
12438 # If the condition evaluates to `true`, then this binding applies to the
12439 # current request.
12440 #
12441 # If the condition evaluates to `false`, then this binding does not apply to
12442 # the current request. However, a different role binding might grant the same
12443 # role to one or more of the principals in this binding.
12444 #
12445 # To learn which resources support conditions in their IAM policies, see the
12446 # [IAM
12447 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
12448 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
12449 # are documented at https://github.com/google/cel-spec.
12450 #
12451 # Example (Comparison):
12452 #
12453 # title: &quot;Summary size limit&quot;
12454 # description: &quot;Determines if a summary is less than 100 chars&quot;
12455 # expression: &quot;document.summary.size() &lt; 100&quot;
12456 #
12457 # Example (Equality):
12458 #
12459 # title: &quot;Requestor is owner&quot;
12460 # description: &quot;Determines if requestor is the document owner&quot;
12461 # expression: &quot;document.owner == request.auth.claims.email&quot;
12462 #
12463 # Example (Logic):
12464 #
12465 # title: &quot;Public documents&quot;
12466 # description: &quot;Determine whether the document should be publicly visible&quot;
12467 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
12468 #
12469 # Example (Data Manipulation):
12470 #
12471 # title: &quot;Notification string&quot;
12472 # description: &quot;Create a notification string with a timestamp.&quot;
12473 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
12474 #
12475 # The exact variables and functions that may be referenced within an expression
12476 # are determined by the service that evaluates it. See the service
12477 # documentation for additional information.
12478 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
12479 # describes the expression, e.g. when hovered over it in a UI.
12480 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
12481 # syntax.
12482 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
12483 # reporting, e.g. a file name and a position in the file.
12484 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
12485 # its purpose. This can be used e.g. in UIs which allow to enter the
12486 # expression.
12487 },
12488 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
12489 # `members` can have the following values:
12490 #
12491 # * `allUsers`: A special identifier that represents anyone who is
12492 # on the internet; with or without a Google account.
12493 #
12494 # * `allAuthenticatedUsers`: A special identifier that represents anyone
12495 # who is authenticated with a Google account or a service account.
12496 # Does not include identities that come from external identity providers
12497 # (IdPs) through identity federation.
12498 #
12499 # * `user:{emailid}`: An email address that represents a specific Google
12500 # account. For example, `[email protected]` .
12501 #
12502 #
12503 # * `serviceAccount:{emailid}`: An email address that represents a Google
12504 # service account. For example,
12505 # `[email protected]`.
12506 #
12507 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
12508 # identifier for a
12509 # [Kubernetes service
12510 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
12511 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
12512 #
12513 # * `group:{emailid}`: An email address that represents a Google group.
12514 # For example, `[email protected]`.
12515 #
12516 #
12517 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
12518 # users of that domain. For example, `google.com` or `example.com`.
12519 #
12520 #
12521 #
12522 #
12523 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
12524 # A single identity in a workforce identity pool.
12525 #
12526 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
12527 # All workforce identities in a group.
12528 #
12529 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
12530 # All workforce identities with a specific attribute value.
12531 #
12532 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
12533 # All identities in a workforce identity pool.
12534 #
12535 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
12536 # A single identity in a workload identity pool.
12537 #
12538 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
12539 # A workload identity pool group.
12540 #
12541 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
12542 # All identities in a workload identity pool with a certain attribute.
12543 #
12544 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
12545 # All identities in a workload identity pool.
12546 #
12547 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
12548 # identifier) representing a user that has been recently deleted. For
12549 # example, `[email protected]?uid=123456789012345678901`. If the user is
12550 # recovered, this value reverts to `user:{emailid}` and the recovered user
12551 # retains the role in the binding.
12552 #
12553 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
12554 # unique identifier) representing a service account that has been recently
12555 # deleted. For example,
12556 # `[email protected]?uid=123456789012345678901`.
12557 # If the service account is undeleted, this value reverts to
12558 # `serviceAccount:{emailid}` and the undeleted service account retains the
12559 # role in the binding.
12560 #
12561 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
12562 # identifier) representing a Google group that has been recently
12563 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
12564 # the group is recovered, this value reverts to `group:{emailid}` and the
12565 # recovered group retains the role in the binding.
12566 #
12567 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
12568 # Deleted single identity in a workforce identity pool. For example,
12569 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
12570 &quot;A String&quot;,
12571 ],
12572 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
12573 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
12574 #
12575 # For an overview of the IAM roles and permissions, see the
12576 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
12577 # a list of the available pre-defined roles, see
12578 # [here](https://cloud.google.com/iam/docs/understanding-roles).
12579 },
12580 ],
12581 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
12582 # prevent simultaneous updates of a policy from overwriting each other.
12583 # It is strongly suggested that systems make use of the `etag` in the
12584 # read-modify-write cycle to perform policy updates in order to avoid race
12585 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
12586 # systems are expected to put that etag in the request to `setIamPolicy` to
12587 # ensure that their change will be applied to the same version of the policy.
12588 #
12589 # **Important:** If you use IAM Conditions, you must include the `etag` field
12590 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
12591 # you to overwrite a version `3` policy with a version `1` policy, and all of
12592 # the conditions in the version `3` policy are lost.
12593 &quot;version&quot;: 42, # Specifies the format of the policy.
12594 #
12595 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
12596 # are rejected.
12597 #
12598 # Any operation that affects conditional role bindings must specify version
12599 # `3`. This requirement applies to the following operations:
12600 #
12601 # * Getting a policy that includes a conditional role binding
12602 # * Adding a conditional role binding to a policy
12603 # * Changing a conditional role binding in a policy
12604 # * Removing any role binding, with or without a condition, from a policy
12605 # that includes conditions
12606 #
12607 # **Important:** If you use IAM Conditions, you must include the `etag` field
12608 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
12609 # you to overwrite a version `3` policy with a version `1` policy, and all of
12610 # the conditions in the version `3` policy are lost.
12611 #
12612 # If a policy does not include any conditions, operations on that policy may
12613 # specify any valid version or leave the field unset.
12614 #
12615 # To learn which resources support conditions in their IAM policies, see the
12616 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
12617 }</pre>
12618 </div>
12619
12620 <div class="method">
12621 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
12622 <pre>Sets the Google Cloud Armor security policy for the specified backend
12623 service. For more information, seeGoogle
12624 Cloud Armor Overview
12625
12626 Args:
12627 project: string, Project ID for this request. (required)
12628 backendService: string, Name of the BackendService resource to which the security policy should be
12629 set. The name should conform to RFC1035. (required)
12630 body: object, The request body.
12631 The object takes the form of:
12632
12633 {
12634 &quot;securityPolicy&quot;: &quot;A String&quot;,
12635 }
12636
12637 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12638 that if you must retry your request, the server will know to ignore the
12639 request if it has already been completed.
12640
12641 For example, consider a situation where you make an initial request and
12642 the request times out. If you make the request again with the same
12643 request ID, the server can check if original operation with the same
12644 request ID was received, and if so, will ignore the second request. This
12645 prevents clients from accidentally creating duplicate commitments.
12646
12647 The request ID must be
12648 a valid UUID with the exception that zero UUID is not supported
12649 (00000000-0000-0000-0000-000000000000).
12650 x__xgafv: string, V1 error format.
12651 Allowed values
12652 1 - v1 error format
12653 2 - v2 error format
12654
12655 Returns:
12656 An object of the form:
12657
12658 { # Represents an Operation resource.
12659 #
12660 # Google Compute Engine has three Operation resources:
12661 #
12662 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
12663 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
12664 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
12665 #
12666 # You can use an operation resource to manage asynchronous API requests.
12667 # For more information, readHandling
12668 # API responses.
12669 #
12670 # Operations can be global, regional or zonal.
12671 #
12672 # - For global operations, use the `globalOperations`
12673 # resource.
12674 # - For regional operations, use the
12675 # `regionOperations` resource.
12676 # - For zonal operations, use
12677 # the `zoneOperations` resource.
12678 #
12679 #
12680 #
12681 # For more information, read
12682 # Global, Regional, and Zonal Resources.
12683 #
12684 # Note that completed Operation resources have a limited
12685 # retention period.
12686 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
12687 # Not present otherwise.
12688 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
12689 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
12690 # set when the operation is created.
12691 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
12692 # text format.
12693 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
12694 # this field will be populated.
12695 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
12696 # operation.
12697 {
12698 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
12699 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
12700 # details. There is a set of defined message types to use for providing
12701 # details.The syntax depends on the error code. For example,
12702 # QuotaExceededInfo will have details when the error code is
12703 # QUOTA_EXCEEDED.
12704 {
12705 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
12706 #
12707 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
12708 # is not enabled:
12709 #
12710 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
12711 # &quot;domain&quot;: &quot;googleapis.com&quot;
12712 # &quot;metadata&quot;: {
12713 # &quot;resource&quot;: &quot;projects/123&quot;,
12714 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
12715 # }
12716 # }
12717 #
12718 # This response indicates that the pubsub.googleapis.com API is not enabled.
12719 #
12720 # Example of an error that is returned when attempting to create a Spanner
12721 # instance in a region that is out of stock:
12722 #
12723 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
12724 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
12725 # &quot;metadata&quot;: {
12726 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
12727 # }
12728 # }
12729 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
12730 # is typically the registered service name of the tool or product that
12731 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
12732 # generated by some common infrastructure, the error domain must be a
12733 # globally unique value that identifies the infrastructure. For Google API
12734 # infrastructure, the error domain is &quot;googleapis.com&quot;.
12735 &quot;metadatas&quot;: { # Additional structured details about this error.
12736 #
12737 # Keys must match a regular expression of `a-z+` but should
12738 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
12739 # length. When identifying the current value of an exceeded limit, the units
12740 # should be contained in the key, not the value. For example, rather than
12741 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
12742 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
12743 # instances that can be created in a single (batch) request.
12744 &quot;a_key&quot;: &quot;A String&quot;,
12745 },
12746 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
12747 # proximate cause of the error. Error reasons are unique within a particular
12748 # domain of errors. This should be at most 63 characters and match a
12749 # regular expression of `A-Z+[A-Z0-9]`, which represents
12750 # UPPER_SNAKE_CASE.
12751 },
12752 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
12753 #
12754 # For example, if a quota check failed with an error indicating the calling
12755 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
12756 # directly to the right place in the developer console to flip the bit.
12757 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
12758 { # Describes a URL link.
12759 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
12760 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
12761 },
12762 ],
12763 },
12764 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
12765 # which can be attached to an RPC error.
12766 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
12767 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
12768 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
12769 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
12770 },
12771 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
12772 &quot;dimensions&quot;: { # The map holding related quota dimensions.
12773 &quot;a_key&quot;: &quot;A String&quot;,
12774 },
12775 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
12776 # type or metric.
12777 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
12778 # or metric.
12779 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
12780 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
12781 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
12782 },
12783 },
12784 ],
12785 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
12786 # This property is optional.
12787 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
12788 },
12789 ],
12790 },
12791 &quot;getVersionOperationMetadata&quot;: {
12792 &quot;inlineSbomInfo&quot;: {
12793 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
12794 # appropriate identifiers.
12795 &quot;a_key&quot;: &quot;A String&quot;,
12796 },
12797 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
12798 # identifiers.
12799 &quot;a_key&quot;: &quot;A String&quot;,
12800 },
12801 },
12802 },
12803 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
12804 # message that was returned, such as `NOT FOUND`.
12805 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
12806 # status code that was returned. For example, a `404` means the
12807 # resource was not found.
12808 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
12809 # defined by the server.
12810 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
12811 # This value is inRFC3339
12812 # text format.
12813 &quot;instancesBulkInsertOperationMetadata&quot;: {
12814 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
12815 # Example key: zones/us-central1-a
12816 &quot;a_key&quot;: {
12817 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
12818 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
12819 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
12820 # error.
12821 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
12822 # if the flow is rolling forward or rolling back.
12823 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
12824 },
12825 },
12826 },
12827 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
12828 # Operation resources.
12829 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
12830 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
12831 # group of operations results from a `bulkInsert` API request.
12832 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
12833 # `update`, or `delete`, and so on.
12834 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
12835 # There is no requirement that this be linear or support any granularity of
12836 # operations. This should not be used to guess when the operation will be
12837 # complete. This number should monotonically increase as the operation
12838 # progresses.
12839 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
12840 # applicable when performing regional operations.
12841 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
12842 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
12843 # this field will contain information on all underlying zonal actions and
12844 # their state.
12845 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
12846 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
12847 # Example key: zones/us-central1-a
12848 &quot;a_key&quot;: {
12849 &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
12850 # populated.
12851 # different programming environments, including REST APIs and RPC APIs. It is
12852 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
12853 # three pieces of data: error code, error message, and error details.
12854 #
12855 # You can find out more about this error model and how to work with it in the
12856 # [API Design Guide](https://cloud.google.com/apis/design/errors).
12857 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
12858 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
12859 # message types for APIs to use.
12860 {
12861 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
12862 },
12863 ],
12864 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
12865 # user-facing error message should be localized and sent in the
12866 # google.rpc.Status.details field, or localized by the client.
12867 },
12868 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
12869 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
12870 },
12871 },
12872 },
12873 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
12874 # This value is inRFC3339
12875 # text format.
12876 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
12877 # following:
12878 # `PENDING`, `RUNNING`, or `DONE`.
12879 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
12880 # operation.
12881 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
12882 # of the target resource.
12883 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
12884 # operations related to creating a snapshot, this points to the disk
12885 # that the snapshot was created from.
12886 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
12887 # `[email protected]` or
12888 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
12889 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
12890 # operation, this field will be populated.
12891 {
12892 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
12893 # Engine returns NO_RESULTS_ON_PAGE if there
12894 # are no results in the response.
12895 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12896 # value format. For example:
12897 #
12898 # &quot;data&quot;: [
12899 # {
12900 # &quot;key&quot;: &quot;scope&quot;,
12901 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12902 # }
12903 {
12904 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12905 # returned. For example, for warnings where there are no results in a list
12906 # request for a particular zone, this key might be scope and
12907 # the key value might be the zone name. Other examples might be a key
12908 # indicating a deprecated resource and a suggested replacement, or a
12909 # warning about invalid network settings (for example, if an instance
12910 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12911 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12912 },
12913 ],
12914 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12915 },
12916 ],
12917 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
12918 # applicable when performing per-zone operations.
12919 }</pre>
12920 </div>
12921
12922 <div class="method">
12923 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
12924 <pre>Returns permissions that a caller has on the specified resource.
12925
12926 Args:
12927 project: string, Project ID for this request. (required)
12928 resource: string, Name or id of the resource for this request. (required)
12929 body: object, The request body.
12930 The object takes the form of:
12931
12932 {
12933 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
12934 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
12935 &quot;A String&quot;,
12936 ],
12937 }
12938
12939 x__xgafv: string, V1 error format.
12940 Allowed values
12941 1 - v1 error format
12942 2 - v2 error format
12943
12944 Returns:
12945 An object of the form:
12946
12947 {
12948 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
12949 # allowed.
12950 &quot;A String&quot;,
12951 ],
12952 }</pre>
12953 </div>
12954
12955 <div class="method">
12956 <code class="details" id="update">update(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
12957 <pre>Updates the specified BackendService resource with the data included in the
12958 request. For more information, seeBackend
12959 services overview.
12960
12961 Args:
12962 project: string, Project ID for this request. (required)
12963 backendService: string, Name of the BackendService resource to update. (required)
12964 body: object, The request body.
12965 The object takes the form of:
12966
12967 { # Represents a Backend Service resource.
12968 #
12969 # A backend service defines how Google Cloud load balancers distribute traffic.
12970 # The backend service configuration contains a set of values, such as the
12971 # protocol used to connect to backends, various distribution and session
12972 # settings, health checks, and timeouts. These settings provide fine-grained
12973 # control over how your load balancer behaves. Most of the settings have
12974 # default values that allow for easy configuration if you need to get started
12975 # quickly.
12976 #
12977 # Backend services in Google Compute Engine can be either regionally or
12978 # globally scoped.
12979 #
12980 # * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices)
12981 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices)
12982 #
12983 # For more information, seeBackend
12984 # Services.
12985 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
12986 # Load Balancers and Traffic Director and requires
12987 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
12988 #
12989 # If set to 0, the cookie is non-persistent and lasts only until
12990 # the end of the browser session (or equivalent). The maximum allowed value
12991 # is two weeks (1,209,600).
12992 #
12993 # Not supported when the backend service is referenced by a URL map that is
12994 # bound to target gRPC proxy that has validateForProxyless field set to true.
12995 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
12996 { # Message containing information of one individual backend.
12997 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
12998 # handle additional traffic or is fully loaded. For usage guidelines, see
12999 # Connection balancing mode.
13000 #
13001 # Backends must use compatible balancing modes. For more information, see
13002 # Supported balancing modes and target capacity settings and
13003 # Restrictions and guidance for instance groups.
13004 #
13005 # Note: Currently, if you use the API to configure incompatible balancing
13006 # modes, the configuration might be accepted even though it has no impact
13007 # and is ignored. Specifically, Backend.maxUtilization is ignored when
13008 # Backend.balancingMode is RATE. In the future, this incompatible combination
13009 # will be rejected.
13010 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
13011 # mode.
13012 # The default value is 1, which means the group serves up to
13013 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
13014 # completely drained, offering 0% of its available capacity. The valid ranges
13015 # are 0.0 and [0.1,1.0].
13016 # You cannot configure a setting larger than 0 and smaller than0.1.
13017 # You cannot configure a setting of 0 when there is only one
13018 # backend attached to the backend service.
13019 #
13020 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
13021 # internet NEGs, regional serverless NEGs, and PSC NEGs.
13022 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
13023 # BalancingMode.
13024 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
13025 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
13026 # Monitoring, but is not used for load balancing.
13027 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
13028 # balancing mode. The valid range is [0.0, 1.0].
13029 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
13030 # long and match the regular expression
13031 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
13032 # first character must be a lowercase letter, and all following
13033 # characters must be a dash, period, underscore, lowercase letter, or
13034 # digit, except the last character, which cannot be a dash, period, or
13035 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
13036 # field can only be used for a global or regional backend service with the
13037 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
13038 },
13039 ],
13040 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
13041 # create the resource.
13042 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
13043 # failover backend can be configured for a given BackendService.
13044 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
13045 # group or network endpoint
13046 # group (NEG) resource. To determine what types of backends a load
13047 # balancer supports, see the [Backend services
13048 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
13049 #
13050 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
13051 # or NEG. Partial URLs are not supported.
13052 #
13053 # If haPolicy is specified, backends must refer to NEG resources of type
13054 # GCE_VM_IP.
13055 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
13056 # guidelines, seeConnection
13057 # balancing mode and Utilization
13058 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
13059 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
13060 # guidelines, seeConnection
13061 # balancing mode and Utilization
13062 # balancing mode.
13063 #
13064 # Not available if the backend&#x27;s balancingMode isRATE.
13065 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
13066 # For usage guidelines, seeConnection
13067 # balancing mode and Utilization
13068 # balancing mode.
13069 #
13070 # Not available if the backend&#x27;s balancingMode isRATE.
13071 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
13072 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
13073 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
13074 # Not available if backend&#x27;s balancingMode is RATE
13075 # or CONNECTION.
13076 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
13077 # Not available if backend&#x27;s balancingMode is RATE
13078 # or CONNECTION.
13079 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
13080 # usage guidelines, seeRate
13081 # balancing mode and Utilization
13082 # balancing mode.
13083 #
13084 # Not available if the backend&#x27;s balancingMode isCONNECTION.
13085 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
13086 # guidelines, seeRate
13087 # balancing mode and Utilization
13088 # balancing mode.
13089 #
13090 # Not available if the backend&#x27;s balancingMode isCONNECTION.
13091 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
13092 # guidelines, seeRate
13093 # balancing mode and Utilization
13094 # balancing mode.
13095 #
13096 # Not available if the backend&#x27;s balancingMode isCONNECTION.
13097 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
13098 #
13099 # For usage guidelines, seeUtilization
13100 # balancing mode.
13101 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
13102 # the backend.
13103 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
13104 },
13105 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
13106 # sending traffic to backends with default preference. The possible values
13107 # are:
13108 #
13109 # - PREFERRED: Backends with this preference level will be
13110 # filled up to their capacity limits first, based on RTT.
13111 # - DEFAULT: If preferred backends don&#x27;t have enough
13112 # capacity, backends in this layer would be used and traffic would be
13113 # assigned based on the load balancing algorithm you use. This is the
13114 # default
13115 &quot;service&quot;: &quot;A String&quot;, # Represents a service backend (e.g., Cloud Run service, PSC Service
13116 # Attachment).
13117 # e.g.
13118 # &quot;run.googleapis.com/projects/123456789/locations/us-central1/services/my-service&quot;
13119 # for Cloud Run service.
13120 # &quot;compute.googleapis.com/projects/123456789/regions/us-central1/serviceAttachments/my-service-attachment&quot;
13121 # for PSC Service Attachment.
13122 &quot;trafficDuration&quot;: &quot;A String&quot;,
13123 },
13124 ],
13125 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
13126 # specified load balancer types.
13127 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
13128 # Pragma or Authorization headers. Up to 5 headers can be specified.
13129 # The cache is bypassed for all cdnPolicy.cacheMode settings.
13130 { # Bypass the cache when the specified request headers are present,
13131 # e.g. Pragma or Authorization headers. Values are case insensitive.
13132 # The presence of such a header overrides the cache_mode setting.
13133 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
13134 # Values are case-insensitive.
13135 },
13136 ],
13137 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
13138 # CDN.
13139 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
13140 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
13141 &quot;A String&quot;,
13142 ],
13143 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
13144 # The name=value pair will be used in the cache key Cloud CDN generates.
13145 &quot;A String&quot;,
13146 ],
13147 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
13148 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
13149 # query_string_whitelist and query_string_blacklist. If neither is set, the
13150 # entire query string will be included. If false, the query string will be
13151 # excluded from the cache key entirely.
13152 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
13153 # parameters will be included. Either specify query_string_whitelist or
13154 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
13155 # not treated as delimiters.
13156 &quot;A String&quot;,
13157 ],
13158 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
13159 # parameters will be excluded. Either specify query_string_whitelist or
13160 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
13161 # not treated as delimiters.
13162 &quot;A String&quot;,
13163 ],
13164 },
13165 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
13166 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
13167 # headers to cache content. Responses without these headers will not be
13168 # cached at Google&#x27;s edge, and will require a full trip to the origin on
13169 # every request, potentially impacting performance and increasing load on
13170 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
13171 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
13172 # Warning: this may result in Cloud CDN caching private,
13173 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
13174 # including common image formats, media (video and audio), and web assets
13175 # (JavaScript and CSS). Requests and responses that are marked as
13176 # uncacheable, as well as dynamic content (including HTML), will not be
13177 # cached.
13178 #
13179 # If no value is provided for cdnPolicy.cacheMode, it defaults
13180 # to CACHE_ALL_STATIC.
13181 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
13182 # used to clamp the max-age (or Expires) value sent to the client. With
13183 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
13184 # response max-age directive, along with a &quot;public&quot; directive. For
13185 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
13186 # from the origin (if specified), or else sets the response max-age
13187 # directive to the lesser of the client_ttl and default_ttl, and also
13188 # ensures a &quot;public&quot; cache-control directive is present.
13189 # If a client TTL is not specified, a default value (1 hour) will be used.
13190 # The maximum allowed value is 31,622,400s (1 year).
13191 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
13192 # responses that do not have an existing valid TTL (max-age or s-maxage).
13193 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
13194 # The value of defaultTTL cannot be set to a value greater than that of
13195 # maxTTL, but can be equal.
13196 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
13197 # will overwrite the TTL set in all responses. The maximum allowed value is
13198 # 31,622,400s (1 year), noting that infrequently accessed objects may be
13199 # evicted from the cache before the defined TTL.
13200 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
13201 # origin.
13202 # Cache directives that attempt to set a max-age or s-maxage higher than
13203 # this, or an Expires header more than maxTTL seconds in the future will
13204 # be capped at the value of maxTTL, as if it were the value of an
13205 # s-maxage Cache-Control directive.
13206 # Headers sent to the client will not be modified.
13207 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
13208 # The maximum allowed value is 31,622,400s (1 year), noting that
13209 # infrequently accessed objects may be evicted from the cache before
13210 # the defined TTL.
13211 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
13212 # to apply fine-grained caching for common errors or redirects.
13213 # This can reduce the load on your origin and improve end-user
13214 # experience by reducing response latency.
13215 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
13216 # negative caching applies to responses with the specified response code
13217 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
13218 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
13219 # to all responses with the specified response code, and override any
13220 # caching headers.
13221 # By default, Cloud CDN will apply the following default TTLs to these
13222 # status codes:
13223 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
13224 # HTTP 404 (Not Found), 410 (Gone),
13225 # 451 (Unavailable For Legal Reasons): 120s
13226 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
13227 # These defaults can be overridden in negative_caching_policy.
13228 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
13229 # negative_caching must be enabled to configure negative_caching_policy.
13230 # Omitting the policy and leaving negative_caching enabled will use
13231 # Cloud CDN&#x27;s default cache TTLs.
13232 # Note that when specifying an explicit negative_caching_policy, you
13233 # should take care to specify a cache TTL for all response codes
13234 # that you wish to cache. Cloud CDN will not apply any default
13235 # negative caching when a policy exists.
13236 { # Specify CDN TTLs for response error codes.
13237 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
13238 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
13239 # specified as values, and you cannot specify a status code more than
13240 # once.
13241 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
13242 # corresponding status code.
13243 # The maximum allowed value is 1800s (30 minutes), noting that
13244 # infrequently accessed objects may be evicted from the cache before the
13245 # defined TTL.
13246 },
13247 ],
13248 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
13249 # requests into a small number of requests to the origin.
13250 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
13251 # content with the origin, or when an error is encountered when refreshing
13252 # the cache.
13253 # This setting defines the default &quot;max-stale&quot; duration for any cached
13254 # responses that do not specify a max-stale directive. Stale responses that
13255 # exceed the TTL configured here will not be served. The default limit
13256 # (max-stale) is 86400s (1 day), which will allow stale content to be
13257 # served up to this limit beyond the max-age (or s-maxage) of a cached
13258 # response.
13259 # The maximum allowed value is 604800 (1 week).
13260 # Set this to zero (0) to disable serve-while-stale.
13261 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
13262 # considered fresh. After this time period, the response will be
13263 # revalidated before being served. Defaults to 1hr (3600s). When serving
13264 # responses to signed URL requests, Cloud CDN will internally behave as
13265 # though all responses from this backend had a &quot;Cache-Control:
13266 # public, max-age=[TTL]&quot; header, regardless of any existing
13267 # Cache-Control header. The actual headers served in responses will not be
13268 # altered.
13269 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
13270 &quot;A String&quot;,
13271 ],
13272 },
13273 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
13274 # backend service.
13275 &quot;connectTimeout&quot;: { # A Duration represents a fixed-length span of time represented # The timeout for new network connections to hosts.
13276 # as a count of seconds and fractions of seconds at nanosecond
13277 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13278 # or &quot;month&quot;. Range is approximately 10,000 years.
13279 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13280 # Durations less than one second are represented with a 0
13281 # `seconds` field and a positive `nanos` field. Must be from 0
13282 # to 999,999,999 inclusive.
13283 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13284 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13285 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13286 },
13287 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
13288 # there is no limit.
13289 #
13290 # Not supported when the backend service is referenced by a URL map that is
13291 # bound to target gRPC proxy that has validateForProxyless field set to true.
13292 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
13293 # not specified, there is no limit.
13294 #
13295 # Not supported when the backend service is referenced by a URL map that is
13296 # bound to target gRPC proxy that has validateForProxyless field set to true.
13297 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
13298 # service. If not specified, there is no limit.
13299 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
13300 # This parameter is respected by both the HTTP/1.1 and HTTP/2
13301 # implementations. If not specified, there is no limit. Setting this
13302 # parameter to 1 will effectively disable keep alive.
13303 #
13304 # Not supported when the backend service is referenced by a URL map that is
13305 # bound to target gRPC proxy that has validateForProxyless field set to true.
13306 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
13307 # not specified, the default is 1.
13308 #
13309 # Not supported when the backend service is referenced by a URL map that is
13310 # bound to target gRPC proxy that has validateForProxyless field set to true.
13311 },
13312 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
13313 # the client&#x27;s Accept-Encoding header.
13314 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
13315 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
13316 # instance. For supported load balancers and protocols, as described inEnabling
13317 # connection draining.
13318 },
13319 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
13320 # tracking policy settings are only available for external passthrough
13321 # Network Load Balancers and internal passthrough Network Load Balancers.
13322 #
13323 # connectionTrackingPolicy cannot be specified with haPolicy.
13324 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
13325 # value is DEFAULT_FOR_PROTOCOL.
13326 #
13327 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
13328 # persist on unhealthy backends only for connection-oriented protocols
13329 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
13330 # Affinity is configured for 5-tuple. They do not persist forUDP.
13331 #
13332 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
13333 # the existing connections on the unhealthy backend are never persisted on
13334 # the unhealthy backend. They are always diverted to newly selected healthy
13335 # backends (unless all backends are unhealthy).
13336 #
13337 # If set to ALWAYS_PERSIST, existing connections always
13338 # persist on unhealthy backends regardless of protocol and session
13339 # affinity. It is generally not recommended to use this mode overriding the
13340 # default.
13341 #
13342 # For more details, see [Connection Persistence for Network Load
13343 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
13344 # and [Connection Persistence for Internal TCP/UDP Load
13345 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
13346 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
13347 # Balancers. This option is not available publicly.
13348 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
13349 # matching traffic (in seconds).
13350 #
13351 # For internal passthrough Network Load Balancers:
13352 #
13353 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
13354 # - It can be set only if Connection Tracking is less than 5-tuple
13355 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
13356 # Mode is PER_SESSION).
13357 #
13358 #
13359 #
13360 # For external passthrough Network Load Balancers the default is 60
13361 # seconds. This option is not available publicly.
13362 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
13363 # options:
13364 #
13365 # - PER_CONNECTION: This is the default mode. The Connection
13366 # Tracking is performed as per the Connection Key (default Hash Method) for
13367 # the specific protocol.
13368 # - PER_SESSION: The Connection Tracking is performed as per
13369 # the configured Session Affinity. It matches the configured Session
13370 # Affinity.
13371 #
13372 #
13373 #
13374 # For more details, see [Tracking Mode for Network Load
13375 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
13376 # and [Tracking Mode for Internal TCP/UDP Load
13377 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
13378 },
13379 &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
13380 # affinity based on HTTP headers, cookies or other properties. This load
13381 # balancing policy is applicable only for HTTP connections. The affinity to a
13382 # particular destination host will be lost when one or more hosts are
13383 # added/removed from the destination service. This field specifies parameters
13384 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
13385 #
13386 # This field is applicable to either:
13387 #
13388 # - A regional backend service with the service protocol set to HTTP,
13389 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
13390 # INTERNAL_MANAGED.
13391 # - A global backend service with the
13392 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
13393 &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
13394 # be used as the hash key for the consistent hash load balancer. If the
13395 # cookie is not present, it will be generated. This field is applicable if
13396 # the sessionAffinity is set to HTTP_COOKIE.
13397 #
13398 # Not supported when the backend service is referenced by a URL map that is
13399 # bound to target gRPC proxy that has validateForProxyless field set to true.
13400 # for load balancing policies that use a consistent hash.
13401 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
13402 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
13403 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
13404 # as a count of seconds and fractions of seconds at nanosecond
13405 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13406 # or &quot;month&quot;. Range is approximately 10,000 years.
13407 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13408 # Durations less than one second are represented with a 0
13409 # `seconds` field and a positive `nanos` field. Must be from 0
13410 # to 999,999,999 inclusive.
13411 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13412 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13413 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13414 },
13415 },
13416 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
13417 # applicable if the sessionAffinity is set toHEADER_FIELD.
13418 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
13419 # 1024. Larger ring sizes result in more granular load distributions. If the
13420 # number of hosts in the load balancing pool is larger than the ring size,
13421 # each host will be assigned a single virtual node.
13422 },
13423 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
13424 # text format.
13425 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
13426 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
13427 # locality_lb_policy.
13428 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
13429 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
13430 # long and match the regular expression
13431 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
13432 # first character must be a lowercase letter, and all following
13433 # characters must be a dash, period, underscore, lowercase letter, or
13434 # digit, except the last character, which cannot be a dash, period, or
13435 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
13436 # field can only be used for a global or regional backend service with the
13437 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
13438 },
13439 ],
13440 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
13441 # custom
13442 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
13443 &quot;A String&quot;,
13444 ],
13445 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
13446 # custom
13447 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
13448 &quot;A String&quot;,
13449 ],
13450 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
13451 # create the resource.
13452 &quot;dynamicForwarding&quot;: { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the
13453 # backend service with dynamic forwarding feature which together with Service
13454 # Extension allows customized and complex routing logic.
13455 &quot;forwardProxy&quot;: { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration.
13456 &quot;enabled&quot;: True or False, # A boolean flag enabling dynamic forwarding proxy.
13457 &quot;proxyMode&quot;: &quot;A String&quot;, # Determines the dynamic forwarding proxy mode.
13458 },
13459 &quot;ipPortSelection&quot;: { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration.
13460 # service. Some ranges are restricted: Restricted
13461 # ranges.
13462 &quot;enabled&quot;: True or False, # A boolean flag enabling IP:PORT based dynamic forwarding.
13463 },
13464 },
13465 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
13466 # this backend service.
13467 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
13468 # global external Application Load Balancer.
13469 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
13470 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
13471 #
13472 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
13473 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
13474 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
13475 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
13476 # externalManagedMigrationTestingPercentage.
13477 #
13478 # Rolling back a migration requires the states to be set in reverse order. So
13479 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
13480 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
13481 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
13482 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
13483 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
13484 # external Application Load Balancer.
13485 #
13486 # The value of this field must be in the range [0, 100].
13487 #
13488 # Session affinity options will slightly affect this routing behavior, for
13489 # more details, see:Session
13490 # Affinity.
13491 #
13492 # This value can only be set if the loadBalancingScheme in the BackendService
13493 # is set to EXTERNAL (when using the classic Application Load Balancer) and
13494 # the migration state is TEST_BY_PERCENTAGE.
13495 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
13496 # as a backup (failover) backend.
13497 # For load balancers that have configurable failover:
13498 # [Internal passthrough Network Load
13499 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
13500 # and [external passthrough Network Load
13501 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
13502 #
13503 # failoverPolicy cannot be specified with haPolicy.
13504 # failover:
13505 # [Internal passthrough Network Load
13506 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
13507 # and [external passthrough
13508 # Network Load
13509 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
13510 # On failover or failback, this field indicates whether connection draining
13511 # will be honored. Google Cloud has a fixed connection draining timeout of
13512 # 10 minutes. A setting of true terminates existing TCP
13513 # connections to the active pool during failover and failback, immediately
13514 # draining traffic. A setting of false allows existing TCP
13515 # connections to persist, even on VMs no longer in the active pool, for up
13516 # to the duration of the connection draining timeout (10 minutes).
13517 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
13518 #
13519 # The default is false.
13520 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
13521 # load balancer are dropped when all primary and all backup backend VMs are
13522 # unhealthy.If set to false, connections are distributed
13523 # among all primary VMs when all primary and all backup backend VMs are
13524 # unhealthy.
13525 # For load balancers that have configurable
13526 # failover:
13527 # [Internal passthrough
13528 # Network Load
13529 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
13530 # and [external passthrough
13531 # Network Load
13532 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
13533 # The default is false.
13534 &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
13535 # failover when the number of healthy primary VMs equals zero.
13536 # For all other values, the load balancer performs a failover when the
13537 # total number of healthy primary VMs is less than this ratio.
13538 # For load balancers that have configurable
13539 # failover:
13540 # [Internal TCP/UDP Load
13541 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
13542 # and [external TCP/UDP Load
13543 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
13544 },
13545 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
13546 # This field is used in optimistic locking. This field will be ignored when
13547 # inserting a BackendService. An up-to-date fingerprint must be provided in
13548 # order to update the BackendService, otherwise the request will
13549 # fail with error 412 conditionNotMet.
13550 #
13551 # To see the latest fingerprint, make a get() request to
13552 # retrieve a BackendService.
13553 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
13554 # Protocol Forwarding.
13555 #
13556 # The backends of this regional backend service must only specify zonal
13557 # network endpoint groups (NEGs) of type GCE_VM_IP.
13558 #
13559 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
13560 # regional backend service must set the network field. All zonal NEGs must
13561 # belong to the same network. However, individual NEGs can
13562 # belong to different subnetworks of that network.
13563 #
13564 # When haPolicy is specified, the set of attached network endpoints across
13565 # all backends comprise an High Availability domain from which one endpoint
13566 # is selected as the active endpoint (the leader) that receives all
13567 # traffic.
13568 #
13569 # haPolicy can be added only at backend service creation time. Once set up,
13570 # it cannot be deleted.
13571 #
13572 # Note that haPolicy is not for load balancing, and therefore cannot be
13573 # specified with sessionAffinity, connectionTrackingPolicy, and
13574 # failoverPolicy.
13575 #
13576 # haPolicy requires customers to be responsible for tracking backend
13577 # endpoint health and electing a leader among the healthy endpoints.
13578 # Therefore, haPolicy cannot be specified with healthChecks.
13579 #
13580 # haPolicy can only be specified for External Passthrough Network Load
13581 # Balancers and Internal Passthrough Network Load Balancers.
13582 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
13583 # achieve it.
13584 #
13585 # Supported values are:
13586 #
13587 # - DISABLED: Fast IP Move is disabled. You can only use the
13588 # haPolicy.leader API to update the leader.
13589 # - &gt;GARP_RA: Provides a method to very quickly define a new network
13590 # endpoint as the leader. This method is faster than updating the leader
13591 # using the haPolicy.leader API. Fast IP move works as follows: The VM
13592 # hosting the network endpoint that should become the new leader sends
13593 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
13594 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
13595 # temporarily associates the forwarding rule IP address with that VM, and
13596 # both new and in-flight packets are quickly delivered to that VM.
13597 #
13598 #
13599 #
13600 # Note the important properties of the Fast IP Move functionality:
13601 #
13602 # - The GARP/RA-initiated re-routing stays active for approximately 20
13603 # minutes. After triggering fast failover, you must also
13604 # appropriately set the haPolicy.leader.
13605 # - The new leader instance should continue to send GARP/RA packets
13606 # periodically every 10 seconds until at least 10 minutes after updating
13607 # the haPolicy.leader (but stop immediately if it is no longer the leader).
13608 # - After triggering a fast failover, we recommend that you wait at least
13609 # 3 seconds before sending another GARP/RA packet from a different VM
13610 # instance to avoid race conditions.
13611 # - Don&#x27;t send GARP/RA packets from different VM
13612 # instances at the same time. If multiple instances continue to send
13613 # GARP/RA packets, traffic might be routed to different destinations in an
13614 # alternating order. This condition ceases when a single instance
13615 # issues a GARP/RA packet.
13616 # - The GARP/RA request always takes priority over the leader API.
13617 # Using the haPolicy.leader API to change the leader to a different
13618 # instance will have no effect until the GARP/RA request becomes
13619 # inactive.
13620 # - The GARP/RA packets should follow the GARP/RA
13621 # Packet Specifications..
13622 # - When multiple forwarding rules refer to a regional backend service,
13623 # you need only send a GARP or RA packet for a single forwarding rule
13624 # virtual IP. The virtual IPs for all forwarding rules targeting the same
13625 # backend service will also be moved to the sender of the GARP or RA
13626 # packet.
13627 #
13628 #
13629 #
13630 # The following are the Fast IP Move limitations (that is, when fastIPMove
13631 # is not DISABLED):
13632 #
13633 # - Multiple forwarding rules cannot use the same IP address if one of
13634 # them refers to a regional backend service with fastIPMove.
13635 # - The regional backend service must set the network field, and all
13636 # NEGs must belong to that network. However, individual
13637 # NEGs can belong to different subnetworks of that network.
13638 # - The maximum number of network endpoints across all backends of a
13639 # backend service with fastIPMove is 32.
13640 # - The maximum number of backend services with fastIPMove that can have
13641 # the same network endpoint attached to one of its backends is 64.
13642 # - The maximum number of backend services with fastIPMove in a VPC in a
13643 # region is 64.
13644 # - The network endpoints that are attached to a backend of a backend
13645 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
13646 # - Traffic directed to the leader by a static route next hop will not be
13647 # redirected to a new leader by fast failover. Such traffic will only be
13648 # redirected once an haPolicy.leader update has taken effect. Only traffic
13649 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
13650 # fast failover.
13651 #
13652 #
13653 # haPolicy.fastIPMove can be set only at backend service creation time.
13654 # Once set, it cannot be updated.
13655 #
13656 # By default, fastIpMove is set to DISABLED.
13657 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
13658 # this service as the active endpoint (the leader) that receives all
13659 # traffic.
13660 #
13661 # When the leader changes, there is no connection draining to persist
13662 # existing connections on the old leader.
13663 #
13664 # You are responsible for selecting a suitable endpoint as the
13665 # leader. For example, preferring a healthy endpoint over unhealthy ones.
13666 # Note that this service does not track backend endpoint health, and
13667 # selects the configured leader unconditionally.
13668 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
13669 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
13670 # that the leader is attached to.
13671 #
13672 # The leader&#x27;s backendGroup must already be specified as a backend of
13673 # this backend service. Removing a backend that is designated as the
13674 # leader&#x27;s backendGroup is not permitted.
13675 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
13676 # designated as the leader.
13677 #
13678 # This network endpoint cannot be detached from the NEG specified in
13679 # the haPolicy.leader.backendGroup until the leader is updated with
13680 # another network endpoint, or the leader is removed from the haPolicy.
13681 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
13682 # instance must already be attached to the NEG specified in the
13683 # haPolicy.leader.backendGroup.
13684 #
13685 # The name must be 1-63 characters long, and comply with RFC1035.
13686 # Authorization requires the following IAM permission on the
13687 # specified resource instance: compute.instances.use
13688 },
13689 },
13690 },
13691 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
13692 # httpsHealthChecks (legacy) resource for health checking this backend
13693 # service. Not all backend services support legacy health checks. See
13694 # Load balancer guide. Currently, at most one health check can be
13695 # specified for each backend service. Backend services with
13696 # instance group or zonal NEG backends must have a health check unless
13697 # haPolicy is specified. Backend services with internet or serverless NEG
13698 # backends must not have a health check.
13699 #
13700 # healthChecks[] cannot be specified with haPolicy.
13701 &quot;A String&quot;,
13702 ],
13703 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
13704 # Not available for internal passthrough Network Load Balancers and external
13705 # passthrough Network Load Balancers.
13706 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
13707 # incoming requests.
13708 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
13709 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
13710 # For security reasons, this value cannot be retrieved via the API.
13711 # Instead, the SHA-256 hash of the value is returned in the
13712 # oauth2ClientSecretSha256 field.
13713 #
13714 # @InputOnly
13715 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
13716 },
13717 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
13718 # defined by the server.
13719 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
13720 # from the client to the backend for proxyless gRPC).
13721 # The possible values are:
13722 #
13723 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
13724 # backend service (Instance Group, Managed Instance Group, Network Endpoint
13725 # Group), regardless of traffic from the client to the proxy. Only IPv4
13726 # health checks are used to check the health of the backends. This is the
13727 # default setting.
13728 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
13729 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
13730 # address).
13731 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
13732 # backend service (Instance Group, Managed Instance Group, Network Endpoint
13733 # Group), regardless of traffic from the client to the proxy. Only IPv6
13734 # health checks are used to check the health of the backends.
13735 #
13736 #
13737 #
13738 # This field is applicable to either:
13739 #
13740 # - Advanced global external Application Load Balancer (load balancing
13741 # scheme EXTERNAL_MANAGED),
13742 # - Regional external Application Load
13743 # Balancer,
13744 # - Internal proxy Network Load Balancer (load balancing
13745 # scheme INTERNAL_MANAGED),
13746 # - Regional internal Application Load
13747 # Balancer (load balancing scheme INTERNAL_MANAGED),
13748 # - Traffic
13749 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
13750 # INTERNAL_SELF_MANAGED).
13751 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
13752 # for backend services.
13753 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
13754 # created for one type of load balancer cannot be used with another.
13755 # For more information, refer toChoosing
13756 # a load balancer.
13757 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
13758 # preference. When you use localityLbPolicies, you must set at least one
13759 # value for either the localityLbPolicies[].policy or the
13760 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
13761 # value set in the localityLbPolicy field.
13762 #
13763 # For an example of how to use this field, seeDefine
13764 # a list of preferred policies.
13765 #
13766 # Caution: This field and its children are intended for use in a service mesh
13767 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
13768 # that have this configuration.
13769 { # Container for either a built-in LB policy supported by gRPC or Envoy or
13770 # a custom one implemented by the end user.
13771 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
13772 # deployed with the client.
13773 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
13774 # by a locally installed custom policy implementation.
13775 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
13776 #
13777 # The value should match the name of a custom implementation registered
13778 # on the gRPC clients. It should follow protocol buffer message naming
13779 # conventions and include the full path (for example,
13780 # myorg.CustomLbPolicy). The maximum length is 256 characters.
13781 #
13782 # Do not specify the same custom policy more than once for a
13783 # backend. If you do, the configuration is rejected.
13784 #
13785 # For an example of how to use this field, seeUse
13786 # a custom policy.
13787 },
13788 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
13789 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
13790 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
13791 # about these values, see the description of localityLbPolicy.
13792 #
13793 # Do not specify the same policy more than once for a
13794 # backend. If you do, the configuration is rejected.
13795 },
13796 },
13797 ],
13798 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
13799 # possible values are:
13800 #
13801 # - ROUND_ROBIN: This is a simple policy in which each healthy
13802 # backend is selected in round robin order. This is the default.
13803 # - LEAST_REQUEST: An O(1) algorithm which
13804 # selects two random healthy hosts and picks the host which has fewer active
13805 # requests.
13806 # - RING_HASH: The ring/modulo hash load balancer implements
13807 # consistent hashing to backends. The algorithm has the property that the
13808 # addition/removal of a host from a set of N hosts only affects 1/N of the
13809 # requests.
13810 # - RANDOM: The load balancer selects a random healthy
13811 # host.
13812 # - ORIGINAL_DESTINATION: Backend host is selected
13813 # based on the client connection metadata, i.e., connections are opened to
13814 # the same address as the destination address of the incoming connection
13815 # before the connection was redirected to the load balancer.
13816 # - MAGLEV: used as a drop in replacement for the ring hash
13817 # load balancer. Maglev is not as stable as ring hash but has faster table
13818 # lookup build times and host selection times. For more information about
13819 # Maglev, see Maglev:
13820 # A Fast and Reliable Software Network Load Balancer.
13821 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
13822 # Load Balancing using weights computed from Backend reported Custom Metrics.
13823 # If set, the Backend Service responses are expected to contain non-standard
13824 # HTTP response header field Endpoint-Load-Metrics. The reported
13825 # metrics to use for computing the weights are specified via thecustomMetrics field.
13826 #
13827 # This field is applicable to either:
13828 # - A regional backend service with the service protocol set to HTTP,
13829 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
13830 # INTERNAL_MANAGED.
13831 # - A global backend service with the
13832 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
13833 # EXTERNAL_MANAGED.
13834 #
13835 #
13836 # If sessionAffinity is not configured—that is, if session
13837 # affinity remains at the default value of NONE—then the
13838 # default value for localityLbPolicy
13839 # is ROUND_ROBIN. If session affinity is set to a value other
13840 # than NONE,
13841 # then the default value for localityLbPolicy isMAGLEV.
13842 #
13843 # Only ROUND_ROBIN and RING_HASH are supported
13844 # when the backend service is referenced by a URL map that is bound to
13845 # target gRPC proxy that has validateForProxyless field set to true.
13846 #
13847 # localityLbPolicy cannot be specified with haPolicy.
13848 &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
13849 # by this backend service. If logging is enabled, logs will be exported to
13850 # Stackdriver.
13851 # backend service.
13852 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
13853 # traffic served by this backend service. The default value is false.
13854 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
13855 { # Determines which HTTP headers will be logged to Stackdriver.
13856 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
13857 },
13858 ],
13859 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
13860 { # Determines which HTTP headers will be logged to Stackdriver.
13861 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
13862 },
13863 ],
13864 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
13865 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
13866 # of optional fields you want to include in the logs. For example:
13867 # serverInstance, serverGkeDetails.cluster,
13868 # serverGkeDetails.pod.podNamespace
13869 &quot;A String&quot;,
13870 ],
13871 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
13872 # service. Configures whether all, none or a subset of optional fields
13873 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
13874 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
13875 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
13876 # service. The value of the field must be in [0, 1]. This configures the
13877 # sampling rate of requests to the load balancer where 1.0 means all logged
13878 # requests are reported and 0.0 means no logged requests are reported. The
13879 # default value is 1.0.
13880 },
13881 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
13882 # service. Duration is computed from the beginning of the stream until the
13883 # response has been completely processed, including all retries. A stream
13884 # that does not complete in this duration is closed.
13885 #
13886 # If not specified, there will be no timeout limit, i.e. the maximum
13887 # duration is infinite.
13888 #
13889 # This value can be overridden in the PathMatcher configuration of the
13890 # UrlMap that references this backend service.
13891 #
13892 # This field is only allowed when the loadBalancingScheme of
13893 # the backend service is INTERNAL_SELF_MANAGED.
13894 # as a count of seconds and fractions of seconds at nanosecond
13895 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
13896 # or &quot;month&quot;. Range is approximately 10,000 years.
13897 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
13898 # Durations less than one second are represented with a 0
13899 # `seconds` field and a positive `nanos` field. Must be from 0
13900 # to 999,999,999 inclusive.
13901 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
13902 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
13903 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
13904 },
13905 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
13906 # controller and read by the backend RCTH
13907 &quot;a_key&quot;: &quot;A String&quot;,
13908 },
13909 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
13910 # The name must be 1-63 characters long, and comply withRFC1035.
13911 # Specifically, the name must be 1-63 characters long and match the regular
13912 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
13913 # character must be a lowercase letter, and all following characters must
13914 # be a dash, lowercase letter, or digit, except the last character, which
13915 # cannot be a dash.
13916 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
13917 #
13918 # This field must be set for Internal Passthrough Network Load Balancers when
13919 # the haPolicy is enabled, and for External Passthrough Network Load
13920 # Balancers when the haPolicy fastIpMove is enabled.
13921 #
13922 # 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.
13923 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
13924 # Load Balancers.
13925 #
13926 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
13927 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
13928 # endpoints in the local zone.
13929 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
13930 # possible values are:
13931 #
13932 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
13933 # is disabled. The load balancer distributes new connections to all
13934 # healthy backend endpoints across all zones.
13935 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
13936 # enabled. The load balancer distributes new connections to all healthy
13937 # backend endpoints in the local zone only. If there are no healthy
13938 # backend endpoints in the local zone, the load balancer distributes
13939 # new connections to all backend endpoints in the local zone.
13940 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
13941 # enabled. The load balancer distributes new connections to all healthy
13942 # backend endpoints in the local zone only. If there aren&#x27;t enough
13943 # healthy backend endpoints in the local zone, the load balancer
13944 # distributes new connections to all healthy backend endpoints across all
13945 # zones.
13946 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
13947 # of healthy backend endpoints in a zone to the count of backend
13948 # endpoints in that same zone is equal to or above this threshold, the
13949 # load balancer distributes new connections to all healthy endpoints in
13950 # the local zone only. When the ratio of the count of healthy backend
13951 # endpoints in a zone to the count of backend endpoints in that same
13952 # zone is below this threshold, the load balancer distributes all new
13953 # connections to all healthy endpoints across all zones.
13954 },
13955 },
13956 &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.
13957 # the backend service.
13958 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
13959 # service.
13960 },
13961 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
13962 # load balancing pool of each individual proxy instance that processes the
13963 # traffic for the given backend service. If not set, this feature is
13964 # considered disabled.
13965 #
13966 # Results of the outlier detection algorithm (ejection of endpoints from the
13967 # load balancing pool and returning them back to the pool) are executed
13968 # independently by each proxy instance of the load balancer. In most cases,
13969 # more than one proxy instance handles the traffic received by a backend
13970 # service. Thus, it is possible that an unhealthy endpoint is detected and
13971 # ejected by only some of the proxies, and while this happens, other proxies
13972 # may continue to send requests to the same unhealthy endpoint until they
13973 # detect and eject the unhealthy endpoint.
13974 #
13975 # Applicable backend endpoints can be:
13976 #
13977 # - VM instances in an Instance Group
13978 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
13979 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
13980 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
13981 # Functions Services
13982 # - Private Service Connect NEGs, that resolve to
13983 # Google-managed regional API endpoints or managed services published using
13984 # Private Service Connect
13985 #
13986 #
13987 #
13988 # Applicable backend service types can be:
13989 #
13990 # - A global backend service with the loadBalancingScheme set to
13991 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
13992 # - A regional backend
13993 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
13994 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
13995 # supported for Serverless NEGs.
13996 #
13997 #
13998 #
13999 # Not supported when the backend service is referenced by a URL map that is
14000 # bound to target gRPC proxy that has validateForProxyless field set to true.
14001 # pool for the backend service.
14002 &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
14003 # or 30s.
14004 #
14005 # After a backend endpoint is returned back to the load balancing pool, it
14006 # can be ejected again in another ejection analysis. Thus, the total ejection
14007 # time is equal to the base ejection time multiplied by the number of times
14008 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
14009 # as a count of seconds and fractions of seconds at nanosecond
14010 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
14011 # or &quot;month&quot;. Range is approximately 10,000 years.
14012 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
14013 # Durations less than one second are represented with a 0
14014 # `seconds` field and a positive `nanos` field. Must be from 0
14015 # to 999,999,999 inclusive.
14016 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
14017 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
14018 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
14019 },
14020 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
14021 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
14022 # return code qualifies as an error. Defaults to 5.
14023 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
14024 # connection errors that are mapped to one of those status codes) before a
14025 # consecutive gateway failure ejection occurs. Defaults to 3.
14026 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
14027 # outlier status is detected through consecutive 5xx. This setting can be
14028 # used to disable ejection or to ramp it up slowly. Defaults to 0.
14029 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
14030 # outlier status is detected through consecutive gateway failures. This
14031 # setting can be used to disable ejection or to ramp it up slowly. Defaults
14032 # to 100.
14033 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
14034 # outlier status is detected through success rate statistics. This setting
14035 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
14036 #
14037 # Not supported when the backend service uses Serverless NEG.
14038 &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
14039 # ejections and backend endpoints being returned to service. The interval is
14040 # equal to the number of seconds as defined in
14041 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
14042 # in outlierDetection.interval.nanos. Defaults to 1 second.
14043 # as a count of seconds and fractions of seconds at nanosecond
14044 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
14045 # or &quot;month&quot;. Range is approximately 10,000 years.
14046 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
14047 # Durations less than one second are represented with a 0
14048 # `seconds` field and a positive `nanos` field. Must be from 0
14049 # to 999,999,999 inclusive.
14050 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
14051 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
14052 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
14053 },
14054 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
14055 # backend service that can be ejected if the ejection conditions are met.
14056 # Defaults to 50%.
14057 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
14058 # enough request volume to detect success rate outliers. If the number of
14059 # backend endpoints is fewer than this setting, outlier detection via success
14060 # rate statistics is not performed for any backend endpoint in the load
14061 # balancing pool. Defaults to 5.
14062 #
14063 # Not supported when the backend service uses Serverless NEG.
14064 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
14065 # (as defined by the interval duration above) to include this backend
14066 # endpoint in success rate based outlier detection. If the volume is lower
14067 # than this setting, outlier detection via success rate statistics is not
14068 # performed for that backend endpoint. Defaults to 100.
14069 #
14070 # Not supported when the backend service uses Serverless NEG.
14071 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
14072 # outlier ejection. The ejection threshold is the difference between the mean
14073 # success rate, and the product of this factor and the standard deviation of
14074 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
14075 # is divided by a thousand to get a double. That is, if the desired factor
14076 # is 1.9, the runtime value should be 1900. Defaults to 1900.
14077 #
14078 # Not supported when the backend service uses Serverless NEG.
14079 },
14080 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
14081 # as part of resource payload.
14082 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
14083 # Tag keys and values have the same definition as resource
14084 # manager tags. The field is allowed for INSERT
14085 # only. The keys/values to set on the resource should be specified in
14086 # either ID { : } or Namespaced format
14087 # { : }.
14088 # For example the following are valid inputs:
14089 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
14090 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
14091 # Note:
14092 # * Invalid combinations of ID &amp; namespaced format is not supported. For
14093 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
14094 &quot;a_key&quot;: &quot;A String&quot;,
14095 },
14096 },
14097 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
14098 # the backend. The default value is 80.
14099 # For internal passthrough Network Load Balancers and external passthrough
14100 # Network Load Balancers, omit port.
14101 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
14102 # communication to the backend VMs in that group. The
14103 # named port must be [defined on each backend instance
14104 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
14105 # This parameter has no meaning if the backends are NEGs. For internal
14106 # passthrough Network Load Balancers and external passthrough Network Load
14107 # Balancers, omit port_name.
14108 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
14109 # with backends.
14110 #
14111 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
14112 # depending on the chosen load balancer or Traffic Director configuration.
14113 # Refer to the documentation for the load balancers or for Traffic Director
14114 # for more information.
14115 #
14116 # Must be set to GRPC when the backend service is referenced by a URL map
14117 # that is bound to target gRPC proxy.
14118 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
14119 # resides. This field is not applicable to global backend services.
14120 # You must specify this field as part of the HTTP request URL. It is
14121 # not settable as a field in the request body.
14122 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
14123 # backend service.
14124 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
14125 # service. This field is applicable to a global backend service with the
14126 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
14127 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use clientTlsPolicy instead.
14128 &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
14129 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
14130 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
14131 # private storage buckets that support Signature Version 4 for authentication.
14132 # The service name for generating the authentication header will always default
14133 # to &#x27;s3&#x27;.
14134 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
14135 # creating a backend that uses AWS v4 signature authentication, but will not
14136 # be returned as part of the configuration when queried with a REST API GET
14137 # request.
14138 #
14139 # @InputOnly
14140 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
14141 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
14142 # keep track of different iterations of your access key.
14143 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
14144 # the name of the region your cloud uses to host your origin. For example,
14145 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
14146 },
14147 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
14148 # that describes how clients should authenticate with this service&#x27;s
14149 # backends.
14150 #
14151 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
14152 # to INTERNAL_SELF_MANAGED.
14153 #
14154 # If left blank, communications are not encrypted.
14155 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
14156 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
14157 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
14158 # specified values, the communication continues. Otherwise, it fails. This
14159 # additional check enables the client to verify that the server is authorized
14160 # to run the requested service.
14161 #
14162 # Note that the contents of the server
14163 # certificate&#x27;s subjectAltName field are configured by the
14164 # Public Key Infrastructure which provisions server identities.
14165 #
14166 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
14167 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
14168 # mode).
14169 &quot;A String&quot;,
14170 ],
14171 },
14172 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14173 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
14174 #
14175 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
14176 # If set, lists of backends and health checks must be both empty.
14177 &quot;A String&quot;,
14178 ],
14179 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
14180 #
14181 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
14182 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
14183 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
14184 #
14185 # Only NONE and HEADER_FIELD are supported
14186 # when the backend service is referenced by a URL map that is bound to
14187 # target gRPC proxy that has validateForProxyless field set to true.
14188 #
14189 # For more details, see:
14190 # [Session
14191 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
14192 #
14193 # sessionAffinity cannot be specified with haPolicy.
14194 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
14195 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
14196 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
14197 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
14198 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
14199 # as a count of seconds and fractions of seconds at nanosecond
14200 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
14201 # or &quot;month&quot;. Range is approximately 10,000 years.
14202 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
14203 # Durations less than one second are represented with a 0
14204 # `seconds` field and a positive `nanos` field. Must be from 0
14205 # to 999,999,999 inclusive.
14206 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
14207 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
14208 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
14209 },
14210 },
14211 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
14212 # Currently this is applicable only for Internal TCP/UDP load balancing,
14213 # Internal HTTP(S) load balancing and Traffic Director.
14214 &quot;policy&quot;: &quot;A String&quot;,
14215 &quot;subsetSize&quot;: 42, # The number of backends per backend group assigned to each proxy instance or
14216 # each service mesh client.
14217 #
14218 # An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm.
14219 # Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`.
14220 # Can only be set if load balancing scheme is `INTERNAL_MANAGED` or
14221 # `INTERNAL_SELF_MANAGED`.
14222 #
14223 # `subset_size` is optional for Internal HTTP(S) load balancing
14224 # and required for Traffic Director.
14225 #
14226 # If you do not provide this value, Cloud Load Balancing will calculate it
14227 # dynamically to optimize the number of proxies/clients visible to each
14228 # backend and vice versa.
14229 #
14230 # Must be greater than 0. If `subset_size` is larger than the number of
14231 # backends/endpoints, then subsetting is disabled.
14232 },
14233 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
14234 # type of load balancer. For more information see,
14235 # Backend service settings.
14236 # The default is 30 seconds.
14237 # The full range of timeout values allowed goes from 1
14238 # through 2,147,483,647 seconds.
14239 #
14240 # This value can be overridden in the PathMatcher configuration of the
14241 # UrlMap that references this backend service.
14242 #
14243 # Not supported when the backend service is referenced by a URL map that is
14244 # bound to target gRPC proxy that has validateForProxyless field set to true.
14245 # Instead, use maxStreamDuration.
14246 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
14247 # when the backend protocol is SSL, HTTPS or HTTP2.
14248 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
14249 # networksecurity.googleapis.com namespace. Can be used in authenticating
14250 # TLS connections to the backend, as specified by the authenticationMode
14251 # field. Can only be specified if authenticationMode is not NONE.
14252 &quot;identity&quot;: &quot;A String&quot;, # Assigns the Managed Identity for the BackendService Workload.
14253 #
14254 #
14255 # Use this property to configure the load balancer back-end to use
14256 # certificates and roots of trust provisioned by the Managed Workload
14257 # Identity system.
14258 #
14259 # The `identity` property is the
14260 # fully-specified SPIFFE ID to use in the SVID presented by the Load
14261 # Balancer Workload.
14262 #
14263 # The SPIFFE ID must be a resource starting with the
14264 # `trustDomain` property value, followed by the path to the Managed
14265 # Workload Identity.
14266 #
14267 # Supported SPIFFE ID format:
14268 #
14269 # - //&lt;trust_domain&gt;/ns/&lt;namespace&gt;/sa/&lt;subject&gt;
14270 #
14271 #
14272 # The Trust Domain within the Managed Identity must refer to a valid
14273 # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
14274 # will be inherited from the Workload Identity Pool.
14275 #
14276 # Restrictions:
14277 #
14278 # - If you set the `identity` property, you cannot manually set
14279 # the following fields:
14280 # - tlsSettings.sni
14281 # - tlsSettings.subjectAltNames
14282 # - tlsSettings.authenticationConfig
14283 #
14284 #
14285 # When defining a `identity` for a RegionBackendServices, the
14286 # corresponding Workload Identity Pool must have a ca_pool
14287 # configured in the same region.
14288 #
14289 # The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
14290 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
14291 # balancer sends this string as the SNI hostname in the TLS connection to
14292 # the backend, and requires that this string match a Subject Alternative
14293 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
14294 # NEG backend, if the SNI is specified here, the load balancer uses it
14295 # regardless of whether the Regional Internet NEG is specified with FQDN or
14296 # IP address and port. When both sni and subjectAltNames[] are specified,
14297 # the load balancer matches the backend certificate&#x27;s SAN only to
14298 # subjectAltNames[].
14299 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
14300 # verifies during a TLS handshake with the backend. When the server
14301 # presents its X.509 certificate to the Load Balancer, the Load Balancer
14302 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
14303 # match one of the subjectAltNames in the list. This field is limited to 5
14304 # entries. When both sni and subjectAltNames[] are specified, the load
14305 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
14306 { # A Subject Alternative Name that the load balancer matches against the SAN
14307 # field in the TLS certificate provided by the backend, specified as either
14308 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
14309 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
14310 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
14311 },
14312 ],
14313 },
14314 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
14315 {
14316 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
14317 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
14318 # and ForwardingRule.
14319 },
14320 ],
14321 }
14322
14323 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14324 that if you must retry your request, the server will know to ignore the
14325 request if it has already been completed.
14326
14327 For example, consider a situation where you make an initial request and
14328 the request times out. If you make the request again with the same
14329 request ID, the server can check if original operation with the same
14330 request ID was received, and if so, will ignore the second request. This
14331 prevents clients from accidentally creating duplicate commitments.
14332
14333 The request ID must be
14334 a valid UUID with the exception that zero UUID is not supported
14335 (00000000-0000-0000-0000-000000000000).
14336 x__xgafv: string, V1 error format.
14337 Allowed values
14338 1 - v1 error format
14339 2 - v2 error format
14340
14341 Returns:
14342 An object of the form:
14343
14344 { # Represents an Operation resource.
14345 #
14346 # Google Compute Engine has three Operation resources:
14347 #
14348 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
14349 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
14350 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
14351 #
14352 # You can use an operation resource to manage asynchronous API requests.
14353 # For more information, readHandling
14354 # API responses.
14355 #
14356 # Operations can be global, regional or zonal.
14357 #
14358 # - For global operations, use the `globalOperations`
14359 # resource.
14360 # - For regional operations, use the
14361 # `regionOperations` resource.
14362 # - For zonal operations, use
14363 # the `zoneOperations` resource.
14364 #
14365 #
14366 #
14367 # For more information, read
14368 # Global, Regional, and Zonal Resources.
14369 #
14370 # Note that completed Operation resources have a limited
14371 # retention period.
14372 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14373 # Not present otherwise.
14374 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14375 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14376 # set when the operation is created.
14377 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14378 # text format.
14379 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14380 # this field will be populated.
14381 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14382 # operation.
14383 {
14384 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14385 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14386 # details. There is a set of defined message types to use for providing
14387 # details.The syntax depends on the error code. For example,
14388 # QuotaExceededInfo will have details when the error code is
14389 # QUOTA_EXCEEDED.
14390 {
14391 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14392 #
14393 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14394 # is not enabled:
14395 #
14396 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14397 # &quot;domain&quot;: &quot;googleapis.com&quot;
14398 # &quot;metadata&quot;: {
14399 # &quot;resource&quot;: &quot;projects/123&quot;,
14400 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14401 # }
14402 # }
14403 #
14404 # This response indicates that the pubsub.googleapis.com API is not enabled.
14405 #
14406 # Example of an error that is returned when attempting to create a Spanner
14407 # instance in a region that is out of stock:
14408 #
14409 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14410 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14411 # &quot;metadata&quot;: {
14412 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14413 # }
14414 # }
14415 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14416 # is typically the registered service name of the tool or product that
14417 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14418 # generated by some common infrastructure, the error domain must be a
14419 # globally unique value that identifies the infrastructure. For Google API
14420 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14421 &quot;metadatas&quot;: { # Additional structured details about this error.
14422 #
14423 # Keys must match a regular expression of `a-z+` but should
14424 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14425 # length. When identifying the current value of an exceeded limit, the units
14426 # should be contained in the key, not the value. For example, rather than
14427 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14428 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14429 # instances that can be created in a single (batch) request.
14430 &quot;a_key&quot;: &quot;A String&quot;,
14431 },
14432 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14433 # proximate cause of the error. Error reasons are unique within a particular
14434 # domain of errors. This should be at most 63 characters and match a
14435 # regular expression of `A-Z+[A-Z0-9]`, which represents
14436 # UPPER_SNAKE_CASE.
14437 },
14438 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14439 #
14440 # For example, if a quota check failed with an error indicating the calling
14441 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14442 # directly to the right place in the developer console to flip the bit.
14443 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14444 { # Describes a URL link.
14445 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14446 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14447 },
14448 ],
14449 },
14450 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14451 # which can be attached to an RPC error.
14452 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14453 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14454 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14455 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14456 },
14457 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14458 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14459 &quot;a_key&quot;: &quot;A String&quot;,
14460 },
14461 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14462 # type or metric.
14463 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14464 # or metric.
14465 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14466 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14467 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14468 },
14469 },
14470 ],
14471 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14472 # This property is optional.
14473 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14474 },
14475 ],
14476 },
14477 &quot;getVersionOperationMetadata&quot;: {
14478 &quot;inlineSbomInfo&quot;: {
14479 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14480 # appropriate identifiers.
14481 &quot;a_key&quot;: &quot;A String&quot;,
14482 },
14483 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14484 # identifiers.
14485 &quot;a_key&quot;: &quot;A String&quot;,
14486 },
14487 },
14488 },
14489 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14490 # message that was returned, such as `NOT FOUND`.
14491 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14492 # status code that was returned. For example, a `404` means the
14493 # resource was not found.
14494 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14495 # defined by the server.
14496 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14497 # This value is inRFC3339
14498 # text format.
14499 &quot;instancesBulkInsertOperationMetadata&quot;: {
14500 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14501 # Example key: zones/us-central1-a
14502 &quot;a_key&quot;: {
14503 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14504 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14505 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14506 # error.
14507 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14508 # if the flow is rolling forward or rolling back.
14509 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14510 },
14511 },
14512 },
14513 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14514 # Operation resources.
14515 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14516 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14517 # group of operations results from a `bulkInsert` API request.
14518 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14519 # `update`, or `delete`, and so on.
14520 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14521 # There is no requirement that this be linear or support any granularity of
14522 # operations. This should not be used to guess when the operation will be
14523 # complete. This number should monotonically increase as the operation
14524 # progresses.
14525 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14526 # applicable when performing regional operations.
14527 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14528 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14529 # this field will contain information on all underlying zonal actions and
14530 # their state.
14531 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14532 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14533 # Example key: zones/us-central1-a
14534 &quot;a_key&quot;: {
14535 &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
14536 # populated.
14537 # different programming environments, including REST APIs and RPC APIs. It is
14538 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14539 # three pieces of data: error code, error message, and error details.
14540 #
14541 # You can find out more about this error model and how to work with it in the
14542 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14543 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14544 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14545 # message types for APIs to use.
14546 {
14547 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14548 },
14549 ],
14550 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14551 # user-facing error message should be localized and sent in the
14552 # google.rpc.Status.details field, or localized by the client.
14553 },
14554 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14555 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14556 },
14557 },
14558 },
14559 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14560 # This value is inRFC3339
14561 # text format.
14562 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14563 # following:
14564 # `PENDING`, `RUNNING`, or `DONE`.
14565 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14566 # operation.
14567 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14568 # of the target resource.
14569 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14570 # operations related to creating a snapshot, this points to the disk
14571 # that the snapshot was created from.
14572 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14573 # `[email protected]` or
14574 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14575 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14576 # operation, this field will be populated.
14577 {
14578 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14579 # Engine returns NO_RESULTS_ON_PAGE if there
14580 # are no results in the response.
14581 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14582 # value format. For example:
14583 #
14584 # &quot;data&quot;: [
14585 # {
14586 # &quot;key&quot;: &quot;scope&quot;,
14587 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14588 # }
14589 {
14590 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14591 # returned. For example, for warnings where there are no results in a list
14592 # request for a particular zone, this key might be scope and
14593 # the key value might be the zone name. Other examples might be a key
14594 # indicating a deprecated resource and a suggested replacement, or a
14595 # warning about invalid network settings (for example, if an instance
14596 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14597 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14598 },
14599 ],
14600 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14601 },
14602 ],
14603 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14604 # applicable when performing per-zone operations.
14605 }</pre>
14606 </div>
14607
14608 </body></html>